lux-cli-di...lat-archive(1)

💅 lux-cli-dist-flat-archive — General Commands Manual, but make it cute 💅

okay bestie, you're on the lux-cli-di...lat-archive(1) page, manual name folded in right at the top like a little name tag. this is the General Commands Manual entry for lux-cli-dist-flat-archive, and we are keeping every flag, default, warning, and example. no cap. 🫶

💖 NAME 💖

lux-cli-dist-flat-archive - Distribute an archive of a flat install tree which includes all dependencies. {n} The resulting archive does not include the etc directory or build dependencies. {n} Unlike a Lux tree, dependency conflicts are not supported/handled.

✨ SYNOPSIS ✨

lux-cli dist flat-archive [-d|--destination] [-c|--compression-method]
[--server] [--extra-servers] [--output-format] [--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_OR_ROCKSPEC]

🦋 DESCRIPTION 🦋

okay so this command distributes an archive of a flat install tree which includes all dependencies. {n} The resulting archive does not include the etc directory or build dependencies. {n} And unlike a Lux tree, dependency conflicts are not supported/handled — that part is literally in the page, so don't expect conflict-handling magic here. periodt. 💅

🎀 OPTIONS 🎀

• -d, --destination <DESTINATION> — where the archive goes, bestie. Defaults to <cwd>/<package>-<version>.zip. {n}
• -c, --compression-method <COMPRESSION_METHOD> — how we're packing the install tree. [default: stored] possible values:
  • stored: Store the install tree as is
  • deflated: Compress the install tree using Deflate
  • bzip2: Compress the install tree using BZIP2
  • xz: Compress the install tree using XZ
  • zstd: Compress the install tree using ZStandard
  • lzma: Compress the install tree using LZMA
• --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)
• --output-format <OUTPUT_FORMAT> — output vibe check. [default: text] possible values:
  • json
  • text
• --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').
• [PACKAGE_OR_ROCKSPEC] — Path to a RockSpec or a package query for a package to distribute. {n} Prioritises local projects if in a workspace, then installed rocks. {n} If there is no matching workspace member or installed rock, {n} a rock will be downloaded and installed to a temporary directory. {n} In case of multiple matches, the latest version will be distributed. {n} {n} Examples: {n} - "pkg" {n} - "pkg@1.0.0" {n} - "pkg>=1.0.0" {n} - "/path/to/foo-1.0.0-1.rockspec" {n} {n} If not set, lux will attempt to distribute the current project. {n} Must be set in multi-project workspaces.

okay that's the whole manual, bestie! cute sign-off time: the footer source/version + date energy is flat-archive and lux-cli-di...lat-archive(1). slay, go distribute that flat archive 💅✨