lux-cli-config-init(1)

📦 version 0.48.0, in nixpkgs unstable

💖 lux-cli-config-init(1) — the config init era is HERE

okay bestie, gather round 💅 this one lives in the General Commands Manual section, and it's literally the glow-up ritual for your config file. buckle up, we're initialising ✨

✨ NAME ✨

lux-cli-config-init — Initialise a new config file 🎀

🌸 SYNOPSIS 🌸

lux-cli config init [--default] [--current] [--server] [--extra-servers]
[--workspace] [--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 🦋

Initialise a new config file. that's it, that's the vibe. your config era starts now 👑

💅 OPTIONS 💅

  • --default — Initialise the default config for this system. If this flag is not set, an empty config file will be created 🫶 (so like, no flag = blank slate, flag = the works)
  • --current — Initialise the config file using the current config, with options picked up from CLI flags. very "copy my current fit" energy ngl
  • --server <server> — Fetch rocks/rockspecs from this server (takes priority over config file). it WINS, no cap 🔥
  • --extra-servers <extra-server> — Fetch rocks/rockspecs from these servers in addition to the main server {n} (overrides any entries in the config file)
  • --workspace — Initialise the config in the current workspace 🏠
  • --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. silent mode, lowkey mysterious
  • --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
bestie this one is deprecated 😭 please use --preset nvim, the glow-up is real
🙈 okay but like... fr fr turn 2FA ON, this flag is the risky vibe and we don't love it
  • --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, you're officially config-pilled 🧚💜

sign-off moment 🌸 — this iconic little page answers to the name init, comes from lux-cli-config-init(1) in the General Commands Manual, and you already have it in your hands right now, so date-wise: now-ish, bestie 🫶💖

📦 where this page comes from