lux-cli-doc(1)

💅 lux-cli-doc — show docs for a rock you already installed

okay so real quick, bestie: this is the lux-cli-doc(1) page from the General Commands Manual, and it's basically the "hey what does this thing actually do" button for your installed rocks. no cap, it's the chillest subcommand in the whole lux family 🫶

✨ SYNOPSIS ✨

lux-cli doc [-p|--package] [--online] [--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]

like, yes, that's a lot of brackets, but most of them are optional-optional, so don't spiral 😭💖

🌸 DESCRIPTION 🌸

Show documentation for an installed rock 💖

that's it. that's the whole job. you point it at a rock, it hands you the docs. iconic behavior, honestly 👑

🎀 OPTIONS 🎀

• -p, --package <PACKAGE> — the package you want docs for ✨ if you don't set it, lux will grab the package that's installed in the tree, or — if your tree has a whole bunch of them — it'll prompt you to pick one. very "let me help you choose" of it 🫶
• --online — skips your local docs entirely and pops the package's homepage open in a browser 🌐 like, go straight to the source, we love a field trip
• --server <server> — fetch rocks/rockspecs from this server (it takes priority over whatever's in your config file) 🔥
• --extra-servers <extra-server> — fetch rocks/rockspecs from these servers in addition to the main server, and it overrides any entries sitting in the config file 👀 extra extra, read all about it
• --namespace <namespace> — specify the luarocks server namespace to use 🗂️
• --lua-dir <prefix> — tells lux the directory to install Lua into if it can't find one already 🔍
• --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 you don't set it, lux will attempt to detect the Lua version, and here's how:
  • 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 🌳 and in a workspace you can use this to specify a detached workspace tree, which is a whole vibe
• --cache-dir <cache-dir> — specifies the cache directory, e.g. for luarocks manifests 🗃️
• --data-dir <data-dir> — specifies the data directory, which is where 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 the commands being executed, which turns on DEBUG logs 🔍 and if you want TRACE logs too, set RUST_LOG=trace. we love a chatty terminal
• --no-progress — don't print any progress bars or spinners 🚫 like, no little animations, just silence
• --no-prompt <NO_PROMPT> — skip prompts and just select 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 (she's retired, let her rest)
• --no-tfa — disable prompts for two-factor authentication (2FA) codes 🚨 but like, it is strongly recommended that you enable 2FA instead — see (https://luarocks.org/settings/two-factor-auth). fr fr, protect your account
• --timeout <seconds> — timeout on network operations, in seconds ⏱️ 0 means no timeout (wait forever, bestie, we'll be here). default is 30
• --max-jobs <MAX_JOBS> — maximum buffer size for parallel jobs, like 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) 💖

ngl, the amount of options here is giving "main character energy" but you literally only need lux-cli doc and a package name. the rest is just ✨control✨

and that's the whole page, bestie 🦋 this slice of wisdom came to you courtesy of the doc source, tagged lux-cli-doc(1) — go forth and read your docs 💅💜