lux-cli-vendor(1)

💖 lux-cli-vendor(1) 💖

Filed under the General Commands Manual — this is the page for lux-cli-vendor(1), and it’s giving “local deps, no remote drama.” 💅

✨ NAME ✨

lux-cli-vendor — Vendor the dependencies of a project or RockSpec locally. When building or installing a package with the --vendor-dir option{n} or the [vendor_dir] config option, Lux will fetch sources from the <vendor-dir>{n} instead of from a remote server. 💖

🦋 SYNOPSIS 🦋

Here’s the whole shape, bestie:

lux-cli vendor [--rockspec] [--no-lock] [--server] [--extra-servers]
[--no-delete] [--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]
[VENDOR_DIR]

🌸 DESCRIPTION 🌸

Okay so this is the main character energy of the page: Vendor the dependencies of a project or RockSpec locally. When building or installing a package with the --vendor-dir option{n} or the [vendor_dir] config option, Lux will fetch sources from the <vendor-dir>{n} instead of from a remote server. No cap. ✨

👑 OPTIONS 👑

One bullet per flag, zero skips — we’re thorough like that. 💅

• --rockspec <ROCKSPEC> — RockSpec to vendor the packages for.{n} If not set, Lux will vendor dependencies of the current project
• --no-lock — Ignore the project's lockfile, if present
• --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{n} (overrides any entries in the config file)
• --no-delete — Don't delete the <vendor-dir> when vendoring,{n} but rather keep all existing contents of the vendor directory
• --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
• --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
• --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)
• --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')
• [VENDOR_DIR] — The directory in which to vendor the dependencies. Must be set if --vendor-dir is not set

---

Cute sign-off: this page comes from the vendor corner and it’s filed under lux-cli-vendor(1) — no date was printed on the footer, so we’re calling it timeless, periodt. 🫶💖