lux-cli-util-completion(1)

hey bestie 💖 welcome to lux-cli-util-completion(1), straight outta the General Commands Manual. this is the lil page for generating shell autocompletion scripts, and we are keeping every flag, every {n}, and every possible value — no cap ✨

🌸 NAME 🌸

lux-cli-util-completion — Generate autocompletion scripts for the shell.{n} Example: lx completion zsh > ~/.zsh/completions/_lx

✨ SYNOPSIS ✨

lux-cli util completion [--target-dir] [--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] [SHELL]

💖 DESCRIPTION 💖

okay so the description is literally the same iconic sentence as NAME: Generate autocompletion scripts for the shell.{n} Example: lx completion zsh > ~/.zsh/completions/_lx

👑 OPTIONS 👑

• --target-dir <TARGET_DIR> — The target directory in which to save completions. If not set, Lux will print the completions to stdout.
• --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).
• --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. vibe check: quiet mode 🫶
• --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').
• [SHELL] — The shell to generate the completion script for.{n} If not set, and no target directory is specified,{n} ux will try to detect the current shell.{n} If not set, and a target directory is specified,{n} Lux will generate completions for all supported shells. Possible values: "bash", "elvish", "fish", "powershell", "zsh"{n} Possible values:
  • bash
  • elvish
  • fish
  • powershell
  • zsh

okay that’s the whole page, bestie 🫶 cute footer sign-off: completion + lux-cli-util-completion(1) — no date is shown on this one, so I’m not inventing one, periodt 💅