lux-cli-path(1)

🌸 NAME 🌸

okay so this is the manual page for lux-cli-path(1) from the General Commands Manual, and it has one very main-character job: lux-cli-path — Return the currently configured package path. That’s the whole name vibe, bestie 🫶

✨ SYNOPSIS ✨

copy-paste this exactly, no cap:

lux-cli path [--server] [--extra-servers] [--namespace] [--lua-dir]
[--lua-version] [--prepend] [--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] [subcommands]

💖 DESCRIPTION 💖

Return the currently configured package path — yes queen, that’s literally it. It gives you back the package path you’ve already configured, and that is its whole iconic purpose 💅✨

🎀 OPTIONS 🎀

Every flag, placeholder, value, and default is here, fr fr. Let’s go through them like a group chat recap 🫶

• --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, and from the Lua installation that is available on the PATH. 👑
• --prepend — Prepend the rocks tree paths to the system paths. 🌈
• --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). 💅

🦋 SUBCOMMANDS 🦋

These are the little side quests, bestie — each one has its own manual page:

• lux-cli-path-full(1) — Generate an export statement for all paths (formatted as a shell command). [Default] ✨
• lux-cli-path-lua(1) — Generate a LUA_PATH expression for lua libraries in the lux tree. (not formatted as a shell command) 💖
• lux-cli-path-c(1) — Generate a LUA_CPATH expression for native lib libraries in the lux tree. (not formatted as a shell command) 🦋
• lux-cli-path-bin(1) — Generate a PATH expression for bin executables in the lux tree. (not formatted as a shell command) 🌈
• lux-cli-path-init(1) — Generate a LUA_INIT expression for the lux loader. (not formatted as a shell command) 🎀
• lux-cli-path-help(1) — Print this message or the help of the given subcommand(s). 🫶

xoxo, cute little footer sign-off 💅 — source/version: path; manual title: lux-cli-path(1); and the date slot didn’t show up in this footer, so I’m not inventing one, bestie 💀✨