lux-cli-ge...te-rockspec(1)

💅 lux-cli-generate-rockspec(1) — General Commands Manual

okay so bestie, you know that thing where you have a whole project and you need a rockspec file to fall out of it like magic? yeah. that's this. it lives in the lux-cli family (the manual name is lux-cli-generate-rockspec, iconic, no notes) and it's here to hand you a rockspec without you hand-writing the thing at 2am. let's GO 🎀

✨ NAME ✨

lux-cli-generate-rockspec — generate a rockspec file from a project 🪄

🌸 SYNOPSIS 🌸

lux-cli generate-rockspec [-p|--package] [--output-format] [--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]

🦋 DESCRIPTION 🦋

generate a rockspec file from a project. that's the whole vibe. you point it at your project, it produces a rockspec, you go live your life 💖

💅 OPTIONS 💅

okay this is the long part but honestly? every single flag matters so we're doing all of them. grab a snack 🍓

• -p, --package <PACKAGE> — the package you want the rockspec generated for 👑
• --output-format <OUTPUT_FORMAT> — defaults to text. the possible values are:
  • json
  • text
• --server <server> — grab rocks/rockspecs from this server. it takes priority over whatever's in the config file ⭐
• --extra-servers <extra-server> — grab rocks/rockspecs from these servers in addition to the main server. this overrides any entries in the config file 🔥
• --namespace <namespace> — specify the luarocks server namespace to use 🌈
• --lua-dir <prefix> — tell it which directory to install Lua in, if it can't find it already
• --lua-version <ver> — which Lua installation to use. the valid versions are: '5.1', '5.2', '5.3', '5.4', '5.5', 'jit' and 'jit52'. if you don't set it, 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's 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. silence. peaceful. 🙈
• --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')

bestie heads up: --nvim is deprecated, so like… use --preset nvim instead, fr fr. and about --no-tfa? it is strongly recommended to enable 2FA instead, so maybe don't ✋

and that's the whole page 💀 you made it to the end, proud of you 🫶

sign-off time: this was generate-rockspec from the lux-cli-ge...te-rockspec(1) manual — General Commands Manual energy, mwah 💋✨