lux-cli-add(1)

🌸 NAME 🌸

okay bestie, welcome to lux-cli-add(1) — the General Commands Manual page for lux-cli add, aka the glow-up command that adds a dependency to the current project. Manual name: lux-cli-add. Main character energy: adding stuff. 💅✨

🎀 SYNOPSIS 🎀

lux-cli add [--force] [-b|--build] [--server] [--extra-servers]
       [-t|--test] [--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]

🦋 DESCRIPTION 🦋

Add a dependency to the current project. That’s the whole vibe. Simple, iconic, slay. 💖

✨ OPTIONS ✨

• --force — Reinstall without prompt if a package is already installed.
• -b, --build <BUILD> — Install the package as a development dependency. Also called dev. 🛠️
• --server <server> — Fetch rocks/rockspecs from this server (takes priority over config file).
• --extra-servers <extra-server> — Fetch rocks/rockspecs from these servers in addition to the main server; overrides any entries in the config file.
• -t, --test <TEST> — Install the package as a test dependency. 🧪
• --namespace <namespace> — Specify the luarocks server namespace to use.
• -p, --package <PACKAGE> — Project to modify.
• --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.

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] — Package or list of packages to install and add to the project's dependencies.
  • Examples: "pkg", "pkg@1.0.0", "pkg>=1.0.0"
  • If you do not specify a version requirement, lux will add a pessimistic ~> constraint on the latest version.
  • You can also specify git packages by providing a git URL shorthand.
    • Example: "github:owner/repo"
    • Supported git host prefixes are: "github:", "gitlab:", "sourcehut:" and "codeberg:".
    • Lux will automatically fetch the latest SemVer tag or commit SHA if no SemVer tag is found.
  • Note that projects with git dependencies cannot be published to luarocks.org

source/version + date check: this footer only gives us add and lux-cli-add(1) — no separate source/version or date line in this copy, bestie. That’s the whole page, and it ate. 💅🎀🦋