lux-cli-path-full(1)

🌸 NAME 🌸

okay bestie, welcome to lux-cli-path-full(1) from the General Commands Manual — this is the full path command for Lux CLI, and it's lowkey the default one. It generates an export statement for all paths (formatted as a shell command). [Default] ✨

✨ SYNOPSIS ✨

lux-cli path full [--no-bin] [--no-loader] [--server] [--extra-servers] [--shell] [--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 🦋

Generate an export statement for all paths (formatted as a shell command). [Default] — yes, it's giving main-character default energy, and we're obsessed. 💅

🎀 OPTIONS 🎀

here's every single flag, bestie — no skips, no cap, fr fr. 🫶

• --no-bin — do not export PATH (bin paths).
• --no-loader — do not add require('lux').loader() to LUA_INIT.

If a rock has conflicting transitive dependencies, disabling the Lux loader may result in the wrong modules being loaded.

• --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{n} (overrides any entries in the config file).
• --shell <SHELL> [default: posix] — the shell to format for. possible values:
  • posix
  • fish
  • nu
• --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.{n} Valid versions are: '5.1', '5.2', '5.3', '5.4', '5.5', 'jit' and 'jit52'.{n} If not set, Lux will attempt to detect the Lua version:{n} - From the current project, if it has an exact Lua version requirement.{n} - From the Lua installation that is available on the PATH.
• --tree <tree> — which tree to operate on.{n} 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,{n} in which the default user install tree resides{n} (e.g. ~/.local/share/lux).
• --variables <variable> — override config variables.{n} Example: lx -v "LUA=/path/to/lua" ...
• --profile <profile> — the build profile to use when compiling packages.{n} Default: release. possible values:
  • release
  • dev
• --verbose — display verbose output of commands executed, enabling DEBUG logs.{n} 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.{n} Prompting is enabled by default in terminal/TTY environments. possible values:
  • true
  • false
• --preset <preset> — configure Lux for a specific environment.{n} Valid presets are: 'nvim'. possible values:
  • nvim: Configure Lux for Neovim plugins
• --nvim — [DEPRECATED] configure lux for installing Neovim packages.{n} Use --preset nvim instead.
• --no-tfa — disable prompts for two-factor authentication (2FA) codes.{n}

It is strongly recommended to enable 2FA instead see https://luarocks.org/settings/two-factor-auth.

• --timeout <seconds> — timeout on network operations, in seconds.{n} 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{n} 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: full; manual: lux-cli-path-full(1); date: not shown in the original footer, so no invented date here 💅✨