lux-cli-dist(1)

📦 version 0.48.0, in nixpkgs unstable

💅 lux-cli-dist(1) — the lux-cli dist glow-up, bestie 💅

okay so this page is fresh out of the General Commands Manual, and it's all about distributing a Lux project. no cap, it's giving "ship it" energy. 🦋✨

✨ NAME ✨

lux-cli-dist — Distribute a Lux project 💖

🎀 SYNOPSIS 🎀

lux-cli dist [--server] [--extra-servers] [--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] <subcommands>

🌸 DESCRIPTION 🌸

short and iconic: Distribute a Lux project. that's the whole assignment, and honestly? slay. 💅

🔥 OPTIONS 🔥

okay bestie, here's the full option menu — every flag, every value, no skips. 👑

  • --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). ✨
  • --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 are:
    • 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). 🔐
  • --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). 💬

🌈 SUBCOMMANDS 🌈

these are the little side quests under dist, and yes, they all matter. 🫶

💫 lux-cli-dist-flat-archive(1)

Distribute an archive of a flat install tree which includes all dependencies. The resulting archive does not include the etc directory or build dependencies. Unlike a Lux tree, dependency conflicts are not supported/handled. 📦

💫 lux-cli-dist-bin(1)

Compile a Lux project, including its dependencies, into a single binary, which runs on systems that do not have Lua installed. 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.

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

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

💫 lux-cli-dist-help(1)

Print this message or the help of the given subcommand(s). 🆘

okay that's the whole page bestie 🫶 — brought to you by the footer source/version vibes of dist and lux-cli-dist(1), and the date isn't printed in this footer, so we're not inventing one. periodt. 💅✨

📦 where this page comes from