lux-cli-pack(1)

πŸ“¦ version 0.48.0, in nixpkgs unstable

πŸŽ€ lux-cli-pack(1) πŸŽ€

Hey bestie πŸ’– welcome to the General Commands Manual page for lux-cli-pack(1). This is the pack command's whole personality: it creates a packed rock for distribution, packing sources or binaries. Lowkey essential, highkey iconic. ✨


🌸 NAME 🌸

lux-cli-pack β€” Create a packed rock for distribution, packing sources or binaries. Periodt. πŸ’…

πŸ¦‹ SYNOPSIS πŸ¦‹

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

πŸ’œ DESCRIPTION πŸ’œ

Create a packed rock for distribution, packing sources or binaries. That's the whole mood. 🫢 No cap.

✨ OPTIONS ✨

Okay bestie, here's every flag and argument β€” yes, all of them, no skipping. The way that this list is complete? We love to see it. πŸ’…

  • --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). ✨
  • --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. 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_OR_ROCKSPEC] β€” Path to a RockSpec or a package query for a package to pack. Prioritises local projects if in a workspace, then installed rocks. If there is no matching workspace member or installed rock, a rock will be downloaded and installed to a temporary directory. In case of multiple matches, the latest version will be packed. Examples: "pkg", "pkg@1.0.0", "pkg>=1.0.0", "/path/to/foo-1.0.0-1.rockspec". If not set, lux will attempt to pack either all workspace members or the current project. To pack a project, lux must be able to generate a release or dev RockSpec. 🌟

That's the whole page, bestie 🫢 β€” footer source/version tag: pack / lux-cli-pack(1). No date shown on this one, just that footer vibe. πŸ’…βœ¨

πŸ“¦ where this page comes from