lux-cli-fmt(1)

📦 version 0.48.0, in nixpkgs unstable

✨ lux-cli-fmt — the format-y glow-up page ✨

okay so this is lux-cli-fmt, a page from the General Commands Manual, and it's literally the glow-up button for your codebase 🎀

🦋 NAME 🦋

lux-cli-fmt — formats the codebase with stylua. that's it, that's the whole vibe. your code goes in messy, comes out iconic 💅

🌸 SYNOPSIS 🌸

lux-cli fmt [--path] [--backend] [--server] [--extra-servers]
[-p|--package] [--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]

bestie look at that flag list. it's giving full glamour, no cap ✨

💖 DESCRIPTION 💖

Formats the codebase with stylua.

literally that. the codebase gets formatted, stylua does the formatting, you get to look like you have your life together 🫶

👑 OPTIONS 👑

okay here's where it gets juicy, one bullet per flag, no skipping, i promised 🙈

  • --path <PATH> — path to a workspace, directory, or Lua file to format. defaults to the current workspace. pick your victim 💅
  • --backend <BACKEND> — the formatter doing the werk. default: stylua

possible values:

  • --server <server> — fetch rocks/rockspecs from this server (takes priority over config file). main character server energy, it wins over the config file fr fr 🔥
  • --extra-servers <extra-server> — fetch rocks/rockspecs from these servers in addition to the main server{n} (overrides any entries in the config file). extra servers, extra flair 💜
  • -p, --package <PACKAGE> — package to format. just the one. it gets the whole makeover 🌸
  • --namespace <namespace> — specify the luarocks server namespace to use 🎀
  • --lua-dir <prefix> — specify the directory in which to install Lua if not found. so if Lua's playing hide and seek, you tell it where to look 🕵️
  • --lua-version <ver> — which Lua installation to use.{n} valid versions are: '5.1', '5.2', '5.3', '5.4', '5.5', 'jit' and 'jit52'.{n} if not set, Lux will attempt to detect the Lua version:{n} - from the current project, if it has an exact Lua version requirement.{n} - from the Lua installation that is available on the PATH
  • --tree <tree> — which tree to operate on.{n} 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. keep it cute, keep it cached 💖
  • --data-dir <data-dir> — specifies the data directory,{n} in which the default user install tree resides{n} (e.g. ~/.local/share/lux). home sweet home for your data 🏡
  • --variables <variable> — override config variables.{n} example: lx -v "LUA=/path/to/lua" ... — you're literally the boss of the config now 💅
  • --profile <profile> — the build profile to use when compiling packages.{n} default: release

possible values:

  • release
  • dev
  • --verbose — display verbose output of commands executed, enabling DEBUG logs.{n} to enable TRACE logs, set RUST_LOG=trace. now you see everything 👀
  • --no-progress — don't print any progress bars or spinners. no spinning, no bars, just silence. some of us need that calm 🧘‍♀️
  • --no-prompt <NO_PROMPT> — skip prompts, selecting the default option.{n} prompting is enabled by default in terminal/TTY environments

possible values:

  • true
  • false
  • --preset <preset> — configure Lux for a specific environment.{n} valid presets are: 'nvim'

possible values:

  • nvim: configure Lux for Neovim plugins 💜
  • --nvim — [DEPRECATED] configure lux for installing Neovim packages.{n} use --preset nvim instead. it's the old way, bestie, we moved on 😭
  • --no-tfa — disable prompts for two-factor authentication (2FA) codes.{n} it is strongly recommended to enable 2FA instead, see (https://luarocks.org/settings/two-factor-auth)
🚨 real talk: this one lowers your security, and the page says it's strongly recommended you enable 2FA instead. keep that lock on, bestie 🔐
  • --timeout <seconds> — timeout on network operations, in seconds.{n} 0 means no timeout (wait forever). default is 30. waiting forever is a choice ⏳
  • --max-jobs <MAX_JOBS> — maximum buffer size for parallel jobs, such as downloading rockspecs and installing rocks. 0 means no limit. default is 0. go wide, no cap 🏃‍♀️💨
  • --no-luarc — do not generate or update a .luarc.json file when building{n} a project. hands off the luarc 🫶
  • --no-wrap-bin — do not wrap Lua bin scripts. no wrapping, no drama 🎀
  • --user-agent <USER_AGENT> — the user agent to set when making web requests. default is "lux/<version>". introduce yourself politely to the internet 🌐
  • -h, --help — print help (see a summary with '-h'). classic, iconic, always there for you 💖

⭐ the cute sign-off ⭐

and that's the whole page, bestie — it lives in the General Commands Manual, it's the fmt subcommand, and it's filed under lux-cli-fmt(1) 🦋

this little moment was brought to you by the source/version line at the bottom, which in the original reads fmt on the left and lux-cli-fmt(1) on the right, with the date sitting quietly in the middle. consider it your receipt, your timestamp, your lil footer energy. slay, go format something pretty ✨💅🎀

📦 where this page comes from