lux-cli-purge(1)

lux-cli-purge(1) from the General Commands Manual has entered the chat — this is the page for lux-cli-purge, bestie. 💅

🌸 NAME 🌸

lux-cli-purge — remove all installed rocks from a tree. That's the whole job: purge mode, no cap. 💖

✨ SYNOPSIS ✨

lux-cli purge [--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]

💖 DESCRIPTION 💖

lux-cli purge removes all installed rocks from a tree. It's giving clean slate era — every installed rock in that tree gets cleared out. Use it when you want that tree wiped of its rocks, and yes, the flags below are how you steer the vibe. 🫶

🎀 OPTIONS 🎀

• --server <server> — fetch rocks/rockspecs from this server. This takes priority over the config file. 🔥
• --extra-servers <extra-server> — fetch rocks/rockspecs from these servers in addition to the main server; this 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 it's not found.
• --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, and 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.
• --no-progress — don't print any progress bars or spinners.
• --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.
• --no-tfa — disable prompts for two-factor authentication (2FA) codes. It is strongly recommended to enable 2FA instead — see https://luarocks.org/settings/two-factor-auth.
• --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').

Cute sign-off, bestie: the footer on this one reads purge and lux-cli-purge(1) (no date shown in the source text, so don't @ me 💀). That's the whole page — go purge responsibly, mwah! 💖🎀