lux-cli-config(1)

📦 version 0.48.0, in nixpkgs unstable

💅 lux-cli-config(1) — the general commands manual, but make it a group chat

okay so bestie, welcome to lux-cli-config 💖 this is the page from the General Commands Manual and it's literally all about poking at your lux configuration. think of it as the settings app but make it terminal. no cap.

✨ NAME ✨

lux-cli-config — Interact with the lux configuration 🎀

🌸 SYNOPSIS 🌸

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

Interact with the lux configuration. that's it, that's the whole vibe ✨ (yes it's also the NAME line, they're matching, it's giving coordinated outfit energy 💅)

👑 OPTIONS 👑

okay here's the full lineup, every single flag, no skips, we're not doing that 🙈

  • --server <server> — Fetch rocks/rockspecs from this server. it takes priority over the config file 👑 so like, this one speaks louder.
  • --extra-servers <extra-server> — Fetch rocks/rockspecs from these servers in addition to the main server. (overrides any entries in the config file — sorry to your config file, it's not their moment 💀)
  • --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. finder's keepers energy 🧚
  • --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:

  • release
  • dev
  • --verbose — Display verbose output of commands executed, enabling DEBUG logs. To enable TRACE logs, set RUST_LOG=trace 🔍 (yes, more logs, go off)
  • --no-progress — Don't print any progress bars or spinners. silent mode, mysterious mode 🕶️
  • --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 the old way, we've moved on, we're thriving 🦋
  • --no-tfa — Disable prompts for two-factor authentication (2FA) codes.
bestie, it is strongly recommended to enable 2FA instead, see (https://luarocks.org/settings/two-factor-auth) 🔐 like fr fr, keep the 2FA on
  • --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 🌈

the little side quests, each with their own page ⭐

💀 reminder that --nvim is deprecated and --no-tfa turns off your 2FA prompts — the manual is very openly not a fan of that last one. respect the caveats, they're there for a reason 🙏

🌸 that's the whole page, you ate it, you understood it, periodt. sourced from config, part of the lux-cli-config(1) family, dated at the bottom of the original page — mwah, love u, go configure something iconic 💖✨🎀🦋👑

📦 where this page comes from