lux-cli-debug-project(1)

📦 version 0.48.0, in nixpkgs unstable

💅 lux-cli-debug-project

okay so bestie, this is a page from the General Commands Manual — it's lux-cli-debug-project(1) and it's literally your little window into whatever project you're standing in rn. pull up a chair 🎀

✨ NAME ✨

lux-cli-debug-project — view information about the current project 👀

🌸 SYNOPSIS 🌸

lux-cli debug project [--list-files] [--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 you got this 🫶

🦋 DESCRIPTION 🦋

View information about the current project. that's it, that's the vibe — it's giving "let me see what's actually going on in here" and honestly? iconic. ✨

💅 OPTIONS 💅

  • --list-files — lists the files that are included. and listen, to avoid copying over huge files that have zero to do with the build process, Lux leaves out hidden files and files that are ignored (like by .gitignore or other .ignore files). so no, your random giant blobs aren't sneaking in 🙈
  • --server <server> — fetch rocks/rockspecs from this server. it takes priority over the config file, so it wins the argument, periodt 👑
  • --extra-servers <extra-server> — fetch rocks/rockspecs from these servers in addition to the main server. this overrides any entries in the config file. more servers, more rocks, no cap 🔥
  • --namespace <namespace> — specify the luarocks server namespace to use.
  • --lua-dir <prefix> — specify the directory to install Lua into, in case it wasn't found on its own. lowkey a rescue mission 🧚
  • --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:
    • 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, you can use this 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, which is where the default user install tree lives (e.g. ~/.local/share/lux). home sweet home 🏠
  • --variables <variable> — override config variables. example: lx -v "LUA=/path/to/lua" ...
  • --profile <profile> — the build profile to use when compiling packages. default is release. possible values:
    • release
    • dev
  • --verbose — display verbose output of the commands executed, which enables DEBUG logs. want TRACE logs too? set RUST_LOG=trace. we love a chatty queen 💬
  • --no-progress — don't print any progress bars or spinners. silence. peace. 🕊️
  • --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. she's retired but not forgotten 🫡
  • --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). like fr fr, turn it on 🔐
  • --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). your little safety net 💖
heads up bestie: that --nvim flag is deprecated — --preset nvim is the main character now. and the --no-tfa thing is a real one, the page says enabling 2FA is strongly recommended, so don't come for me if you skip it 💀

k bye ily, go debug that project 🌟 — signed off from the lux-cli-debug-project(1) page, source/version project, General Commands Manual. mwah 💋🎀

📦 where this page comes from