lux-cli-path-lua(1)

💅 lux-cli-path-lua — bestie edition

okay so this is a page from the General Commands Manual and it's literally about lux-cli-path-lua, and I'm gonna walk you through it like we're texting at 2am 🫶

---

✨ NAME ✨

lux-cli-path-lua — generates a LUA_PATH expression for lua libraries in the lux tree. and no, it's not formatted as a shell command, so don't come for me about it 💅

---

🌸 SYNOPSIS 🌸

lux-cli path lua [--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 🦋

So the whole vibe: it generates a LUA_PATH expression for the lua libraries chillin' in the lux tree. 🧚

And again, just so we're clear — it is not formatted as a shell command. like, that's the whole note in the manpage, and I'm not gonna hide it from you ✨

---

👑 OPTIONS 👑

okay this is the main character section, buckle up 🎀

• --server <server> — fetches rocks/rockspecs from this server. it takes priority over whatever your config file says, no cap 💅
• --extra-servers <extra-server> — fetches rocks/rockspecs from these servers in addition to the main server. this overrides any entries in the config file 🔥
• --namespace <namespace> — specifies the luarocks server namespace to use 🌸
• --lua-dir <prefix> — specifies the directory to install Lua into if it's 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 it's 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'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 — displays 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, we're keeping it lowkey 🍓
• --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) 🌈

---

heads up bestie: --nvim is deprecated, fr fr — use --preset nvim instead and you're slaying 😭

---

and that's the whole page, you ate that 💖 this was lux-cli-path-lua(1), sittin' pretty in the lua manual section, brought to you by the legend who wrote this manpage — mwah, iconic, periodt 👑✨🌸