lux-cli-new(1)

🎀 NAME 🎀

okay so bestie, welcome to lux-cli-new(1) — the new page from the General Commands Manual. The assignment is literally: lux-cli-new — Create a new Lua project. main character energy only. 💅✨

✨ SYNOPSIS ✨

lux-cli new [--name] [--description] [--server] [--extra-servers]
[--license] [--maintainer] [--namespace] [--labels] [--lua-dir]
[--lua-version] [--lua-versions] [--main] [--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] <TARGET>

okay this synopsis is giving “all the flags showed up to the group chat at once,” but it’s exact and iconic. 👑

🦋 DESCRIPTION 🦋

Create a new Lua project. periodt. You’re here to spin up a fresh Lua project and pick your setup details. 🌸

💖 OPTIONS 💖

• --name <NAME> — The project’s name. 🎀
• --description <DESCRIPTION> — The description of the project. 🌸
• --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). ✨
• --license <LICENSE> — The license of the project. Generic license names will be inferred. 💜
• --maintainer <MAINTAINER> — The maintainer of this project. Does not have to be the code author. 🫶
• --namespace <namespace> — Specify the luarocks server namespace to use. 🌈
• --labels <LABELS> — A comma-separated list of labels to apply to this project. 💅
• --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.
• --lua-versions <LUA_VERSIONS> — A version constraint on the required Lua version for this project. Examples: ">=5.1", "5.1". 🔥
• --main <MAIN> — Possible values:
  • src
  • lua
  • none
• --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 warning: 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'). 💖
• <TARGET> — The directory of the project. 👑

okay that’s the whole new page, bestie. Signed off from lux-cli-new(1) — footer source/version: new; manual: lux-cli-new(1); date: not shown, so no invented dates here. go make a project that eats. 💖🫶✨