lux-cli-dist-bin(1)

📦 version 0.48.0, in nixpkgs unstable

🦋 lux-cli-dist-bin(1) — General Commands Manual, but make it cute 🦋

okay so this whole page is the lux-cli-dist-bin(1) manual from the General Commands Manual, and we're about to compile a Lux project into a single binary with zero boring vibes. Let's go 💅

🌸 NAME 🌸

Compile a Lux project — including its dependencies — into a single binary that runs on systems where Lua isn't installed. Periodt. 🫶

Projects with native Lua modules are not single binaries: those modules get copied as shared libraries next to the output binary, and must be shipped alongside it. Same energy as flat-archive: dependency conflicts are not supported/handled. 🚨

The entrypoint lives in the lux.toml's [run] field, like:

[run]
args = ["src/main.lua"]

✨ SYNOPSIS ✨

lux-cli dist bin [-o|--output] [-p|--package] [--server]
[--extra-servers] [--output-format] [--namespace] [--lua-dir]
[--lua-version] [--tree] [--cache-dir] [--data-dir] [--variables]
[--profile] [--verbose] [--no-progress] [--no-prompt] [--preset]
[--nvim] [--no-tfa] [--timeout] [--max-jobs] [--no-luarc]
[--no-wrap-bin] [--user-agent] [-h|--help]

🦋 DESCRIPTION 🦋

Compile a Lux project — including its dependencies — into a single binary that runs on systems where Lua isn't installed. Yep, we're saying it again because it's iconic. 👑

Projects with native Lua modules are not single binaries: the modules are copied as shared libraries next to the output binary, and must be shipped alongside it. As with flat-archive, dependency conflicts are not supported/handled. No cap, that's the caveat. 💀

The entrypoint is specified via the lux.toml's [run] field, e.g.:

[run]
args = ["src/main.lua"]

👑 OPTIONS 👑

okay bestie, here is every single flag. no skips, no summarizing, we're eating the whole menu 🍓

  • -o, --output <OUTPUT> — Output path for the compiled binary. Defaults to <package>[.exe] in the current directory. 💖
  • -p, --package <PACKAGE> — Package to compile. Prioritises local projects if in a workspace. If not set, lux will attempt to compile the current project. Must be set in multi-project workspaces. 🎀
  • --server <server> — Fetch rocks/rockspecs from this server (takes priority over config file). 🌐
  • --extra-servers <extra-server> — Fetch rocks/rockspecs from these servers in addition to the main server (overrides any entries in the config file). ✨
  • --output-format <OUTPUT_FORMAT> [default: text] — Possible values:
    • json
    • text
  • --namespace <namespace> — Specify the luarocks server namespace to use. 🦋
  • --lua-dir <prefix> — Specify the directory in which to install Lua if not found. 💜
  • --lua-version <ver> — Which Lua installation to use. Valid versions are: '5.1', '5.2', '5.3', '5.4', '5.5', 'jit' and 'jit52'. If not set, Lux will attempt to detect the Lua version: from the current project, if it has an exact Lua version requirement; from the Lua installation that is available on the PATH. 🔥
  • --tree <tree> — Which tree to operate on. In a workspace, this can be used to specify a detached workspace tree. 🌈
  • --cache-dir <cache-dir> — Specifies the cache directory, e.g. for luarocks manifests. 🗂️
  • --data-dir <data-dir> — Specifies the data directory, in which the default user install tree resides (e.g. ~/.local/share/lux). 🏠
  • --variables <variable> — Override config variables. Example: lx -v "LUA=/path/to/lua" ... 🧚
  • --profile <profile> — The build profile to use when compiling packages. Default: release. Possible values:
    • release
    • dev
  • --verbose — Display verbose output of commands executed, enabling DEBUG logs. To enable TRACE logs, set RUST_LOG=trace. 📢
  • --no-progress — Don't print any progress bars or spinners. 🙈
  • --no-prompt <NO_PROMPT> — Skip prompts, selecting the default option. Prompting is enabled by default in terminal/TTY environments. Possible values:
    • true
    • false
  • --preset <preset> — Configure Lux for a specific environment. Valid presets are: 'nvim'. Possible values:
    • nvim: Configure Lux for Neovim plugins
  • --nvim — DEPRECATED: Configure lux for installing Neovim packages. Use --preset nvim instead. 💅
  • --no-tfa — Disable prompts for two-factor authentication (2FA) codes. It is strongly recommended to enable 2FA instead see (https://luarocks.org/settings/two-factor-auth). 🔐
bestie, the 2FA rec is real — enable it if you can, okay? 🫶
  • --timeout <seconds> — Timeout on network operations, in seconds. 0 means no timeout (wait forever). Default is 30. ⏳
  • --max-jobs <MAX_JOBS> — Maximum buffer size for parallel jobs, such as downloading rockspecs and installing rocks. 0 means no limit. Default is 0. ⚡
  • --no-luarc — Do not generate or update a .luarc.json file when building a project. 🚫
  • --no-wrap-bin — Do not wrap Lua bin scripts. 🎀
  • --user-agent <USER_AGENT> — The user agent to set when making web requests. Default is "lux/<version>". 🌸
  • -h, --help — Print help (see a summary with '-h'). 🫶

okay that's the whole page, bestie — source/version bin, manual lux-cli-dist-bin(1) — periodt 💅✨

📦 where this page comes from