Installation¶

You can install Leste using LuaRocks or by cloning the repository — choose whichever fits your workflow best.

Installing Leste with LuaRocks¶

Leste is conveniently available through LuaRocks, the Lua package manager. If you already have LuaRocks installed, you can install Leste with:

luarocks install leste

This command will automatically download Leste from the LuaRocks repository and generate the leste script for you. This script enables you to run Leste directly from your command line.

Ensuring Leste Accessibility¶

To ensure you can execute Leste from any directory in your terminal, you need to add the LuaRocks bin directory to your system's PATH environment variable. This variable defines the locations your system searches for executable programs.

By default, LuaRocks installs command-line scripts like leste in a specific directory depending on your installation type:

System-wide installation: /usr/local/bin
Per-user installation:
- ~/.luarocks/bin (on Unix-like systems)
- %APPDATA%/luarocks/bin (on Windows)

Installing Leste by cloning this repository¶

Clone the repository from GitHub:

git clone https://github.com/AdaiasMagdiel/Leste.git

Navigate into the Leste directory:
```
cd Leste
```
Create a script named leste (or leste.bat for Windows) pointing to the leste/main.lua file:

=== "Unix-like (Linux, macOS)"

#!/bin/bash

lua path/to/leste/main.lua $*

=== "Windows"

@echo off

lua path\to\leste\main.lua %*

Ensure the script is added to your system's PATH so it can be executed from anywhere.

Next Steps¶

Continue to Usage to learn the CLI's arguments and options.