lux-cli-path-bin(1)

💖 NAME 💖

This is the General Commands Manual page for lux-cli-path-bin(1) — aka the lux-cli path bin command — and it is literally here to generate a PATH expression for bin executables in the lux tree.

Important vibe check: it is not formatted as a shell command. No cap. 🫶

🌸 SYNOPSIS 🌸

lux-cli path bin [--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]

🦋 DESCRIPTION 🦋

Bestie, this one generates a PATH expression for bin executables in the lux tree. Generates it! For bin executables! In the lux tree! 🌈

And the key little caption here is: not formatted as a shell command. That part matters, so keep it in mind. 💅

✨ OPTIONS ✨

• --server <server> — Fetch rocks/rockspecs from this server. It takes priority over the config file. 👑
• --extra-servers <extra-server> — Fetch rocks/rockspecs from these servers in addition to the main server, and yes, this overrides any entries in the config file. Extra servers, extra sparkle. ✨
• --namespace <namespace> — Specify the luarocks server namespace to use.
• --lua-dir <prefix> — Specify the directory in which to install Lua if it’s not found. Gotta put it somewhere, bestie. 🎀
• --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. Tree selection? Iconic. 🌳
• --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). Main character data dir energy. 💾
• --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. So chatty, so useful. 🗣️
• --no-progress — Don’t print any progress bars or spinners. Peace and quiet, periodt. 🤫
• --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. It’s giving “we moved on, but we still respect the journey.” 💅
• --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, please enable 2FA if you can. 🔐
• --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. Leave that file alone, respectfully. 🫶
• --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'). Tiny help, big slay. 💖

xoxo, from the bin source/version of lux-cli-path-bin(1) — no date in the footer, so I’m not inventing one, bestie 💅🫶