lux-cli-check(1)

📦 version 0.48.0, in nixpkgs unstable

✨ lux-cli-check(1) — the check command, bestie edition ✨

okay so this is a page from the General Commands Manual (yes, that's the manual name, we're fancy now 💅), and it's all about lux-cli-check — the glow-up command that type checks your project. Buckle up 🎀

🌸 NAME 🌸

lux-cli-check — [EXPERIMENTAL] type check the current project based on EmmyLua/LuaCATS annotations.

It respects .emmyrc.json and .luarc.json files in the project directory. periodt. 🫶

bestie, note the [EXPERIMENTAL] tag — it's literally right there in the name section, so don't come for me if it's still cooking 😭

🦋 SYNOPSIS 🦋

lux-cli check [--path] [-i|--ignore] [--server] [--extra-servers]
[--output-format] [--namespace] [--output] [--lua-dir]
[--warnings-as-errors] [--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, that's the whole vibe in one block. slay ✨

💖 DESCRIPTION 💖

[EXPERIMENTAL] Type check the current project based on EmmyLua/LuaCATS annotations. no cap, it's doing real analysis on your Lua.

And it respects .emmyrc.json and .luarc.json files in the project directory — so if you already have your config set up, it just gets you. main character energy tbh 👑

🌈 OPTIONS 🌈

okay this is the long part, but every single one is here, i promise, no skipping, we don't do that 💀

  • --path <PATH> — path to a workspace, directory, or Lua file to check. defaults to the current workspace, iykyk.
  • -i, --ignore <IGNORE> — a comma-separated list of ignore patterns. patterns must follow glob syntax. and heads up: Lux will automatically add top-level ignored project files for you 🫶
  • --server <server> — fetch rocks/rockspecs from this server (and yep, it takes priority over the 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 — so if you had config entries, they're getting ghosted 👻)
  • --output-format <OUTPUT_FORMAT> [default: text] — the output format. possible values:
    • json
    • text
  • --namespace <namespace> — specify the luarocks server namespace to use.
  • --output <OUTPUT> [default: stdout] — output destination. (either stdout or a file path — and it's only used when the output format is json, so don't try it with text, ok?)
  • --lua-dir <prefix> — specify the directory in which to install Lua if it's not found.
  • --warnings-as-errors — treat warnings as errors. yeah. they're not just suggestions anymore 😤
  • --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.
    • from the Lua installation that is available on the PATH.
  • --tree <tree> — which tree to operate on. in a workspace, this can be used to specify a detached workspace tree. fancy 🧚
  • --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. go off, debug queen 🔥
  • --no-progress — don't print any progress bars or spinners. clean output, no chaos.
  • --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. it's giving legacy era, we've moved on 💅
  • --no-tfa — disable prompts for two-factor authentication (2FA) codes.
okay real talk: it is strongly recommended to enable 2FA instead — see <https://luarocks.org/settings/two-factor-auth>. please, bestie, protect your account 🙈
  • --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'). the classic 🎀

that's literally everything, not a single flag left behind 💜

💌 okay so this page is signed off with check on one side and lux-cli-check(1) on the other — that's the source/version and the page name, no date to be found, so that's all we've got, bestie. mwah, go type check something iconic 💋✨

📦 where this page comes from