lux-cli-install(1)

💅 lux-cli-install(1) — the group-chat guide 💅

okay bestie, welcome to lux-cli-install 💖 this is the page from the General Commands Manual, and it's literally all about installing a rock for use on the system. yes, the whole vibe. let's get into it 🎀

---

✨ NAME ✨

lux-cli-install — Install a rock for use on the system 🫶

🌸 SYNOPSIS 🌸

lux-cli install [--pin] [--force] [--server] [--extra-servers] [--path]
[--namespace] [-p|--package] [--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]
[PACKAGE_REQ]

like, that's the whole shape of it. iconic honestly 💅

🦋 DESCRIPTION 🦋

Install a rock for use on the system ✨ that's it, that's the whole job, and it ate.

👑 OPTIONS 👑

• --pin — Pin the packages so that they don't get updated 🔒 like, hands off, these are staying exactly where they are.
• --force — Reinstall without prompt if a package is already installed 💀 no asking, no "are you sure", it just goes.
• --server <server> — Fetch rocks/rockspecs from this server (takes priority over config file) 🔥 so it overrides whatever your config file says, main character energy.
• --extra-servers <extra-server> — Fetch rocks/rockspecs from these servers in addition to the main server{n} (overrides any entries in the config file) 🌈 the {n} is literally in there, keep it, it's giving formatting artifact.
• --path <path> — Install a local project from this directory, rather than a remote package 📁 local bestie hours, no network needed.
• --namespace <namespace> — Specify the luarocks server namespace to use 🧚
• -p, --package <PACKAGE> — Package to install when installing from a multi-project workspace. Ignored if the --path option is unset ⭐ lowkey important: no --path, and this does nothing.
• --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 💜 so many choices, and it auto-detects if you don't pick.
• --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) 🎀 path is exact, don't touch it.
• --variables <variable> — Override config variables.{n} Example: `lx -v "LUA=/path/to/lua" ...` ✨ note that example uses lx, not lux-cli — that's how it is in the original, so it stays.
• --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 🙈 clean output, no vibes.
• --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 💀 yeah it's deprecated bestie, use the shiny new one.
• --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)

🚨 okay real talk: this one disables your 2FA prompts, and the page strongly recommends you enable 2FA instead. so like... think about 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 🔥 maximum chaos mode is the default.
• --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') 💖 little hint inside the hint.
• [PACKAGE_REQ] — Package or list of packages to install 📦 yes, a list. go off.

---

and that's the whole page bestie, no notes 💜 mwah 😘

✨ cute little sign-off ✨ — this lil manual page is sourced from install and it's the lux-cli-install(1) page from the General Commands Manual (no date on the footer, so like... timeless 💅). go install something iconic 🫶