lux-cli-unpin(1)

okay bestie, welcome to the lux-cli-unpin(1) page from the General Commands Manual — manual name folded in, cute, done. The whole vibe is: we’re unpinning a rock so updates can do their thing. 💅✨

🎀 NAME 🎀

lux-cli-unpin — Unpins an existing rock, allowing updates to alter the package.

✨ SYNOPSIS ✨

lux-cli unpin [-b|--build] [--server] [-t|--test] [--extra-servers]
[-p|--package] [--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]
[PACKAGE_REQ]

💖 DESCRIPTION 💖

This command unpins an existing rock, allowing updates to alter the package. That’s the main-character job, and it ate. 🍓

🌸 OPTIONS 🌸

• -b, --build <BUILD> — pin a development dependency. Also called dev. (Yes, the manpage says “Pin” on the unpin page — we don’t ask questions, bestie. 💀)
• --server <server> — fetch rocks/rockspecs from this server (takes priority over config file).
• -t, --test <TEST> — pin a test dependency.
• --extra-servers <extra-server> — fetch rocks/rockspecs from these servers in addition to the main server (overrides any entries in the config file).
• -p, --package <PACKAGE> — project to modify.
• --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. 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.
• --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.

bestie, the manpage says 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').
• [PACKAGE_REQ] — installed package or dependency to pin. If pinning a dependency in a project, this should be the package name.

and that’s the page, signed off at the bottom by unpin on the left and lux-cli-unpin(1) on the right — footer energy, bestie. 💖🎀