lux-cli-util(1)

💅 NAME 💅

It's lux-cli-util — straight out of the General Commands Manual — and it's your girl for infrequently used commands such as for generating shell completions and man pages. Lowkey the utility drawer of Lux, but make it iconic. 💖

✨ SYNOPSIS ✨

lux-cli util [--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 🦋

Infrequently used commands such as for generating shell completions and man pages. That's the whole vibe: it's giving "rarely needed, still slaying." 💅

🎀 OPTIONS 🎀

Tiny note bestie: I kept the little literal {n} bits exactly as they appear in the original, because we do not erase the lore. 🫶

• --server <server> — fetch rocks/rockspecs from this server (takes priority over config file). Priority queen.
• --extra-servers <extra-server> — fetch rocks/rockspecs from these servers in addition to the main server{n} (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 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. Workspace girlies, this one's for you.
• --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). Home sweet data home.
• --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. Trace girlies rise.
• --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. She's retired but still cute.
• --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). Security warning, bestie: strongly recommended to enable 2FA.
• --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').

🌸 SUBCOMMANDS 🌸

• lux-cli-util-completion(1) — generate autocompletion scripts for the shell.{n} Example: lx completion zsh > ~/.zsh/completions/_lx
• lux-cli-util-man(1) — generate manpages.
• lux-cli-util-help(1) — print this message or the help of the given subcommand(s).

🎀 cute sign-off: the footer says util and lux-cli-util(1) — no date is in the original footer, so I'm not inventing one, bestie. Stay slaying. 💅