lux-cli-run(1)

📦 version 0.48.0, in nixpkgs unstable

💅 lux-cli-run(1) — like, the manual, but make it make sense 💅

okay so bestie, you're looking at the General Commands Manual page for lux-cli-run, and I promise this is gonna be way less scary than it sounds. This is the glow-up guide to running your current project with whatever arguments you wanna throw at it. 🫶

✨ NAME ✨

lux-cli-run — run the current project with the provided arguments. That's it, that's the whole vibe. 🎀

🌸 SYNOPSIS 🌸

lux-cli run [--no-loader] [--dir] [--server] [--extra-servers]
[--no-lock] [--namespace] [--only-deps] [--lua-dir] [-p|--package]
[--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] [ARGS]

🦋 DESCRIPTION 🦋

Run the current project with the provided arguments. Literally the main character of this whole page. 👑

💖 OPTIONS 💖

  • --no-loader — Do not add require('lux').loader() to LUA_INIT.{n} If a rock has conflicting transitive dependencies,{n} disabling the Lux loader may result in the wrong modules being loaded. ⚠️ so like, be careful with this one, yeah?
  • --dir <DIR> — Path in which to run the command.{n} Defaults to the project root. slay, it just knows where to go. 📁
  • --server <server> — Fetch rocks/rockspecs from this server (takes priority over config file). it said what it said, priority. 💅
  • --extra-servers <extra-server> — Fetch rocks/rockspecs from these servers in addition to the main server{n} (overrides any entries in the config file). more servers, more rocks, no cap. 🌐
  • --no-lock — Ignore the project's lockfile and don't create one. live your truth, lock-free. 🔓
  • --namespace <namespace> — Specify the luarocks server namespace to use. iykyk. 🗂️
  • --only-deps — Build only the dependencies. not the whole thing, just the supporting cast. 🎭
  • --lua-dir <prefix> — Specify the directory in which to install Lua if not found. it's giving "found family" energy. 🏠
  • -p, --package <PACKAGE> — Package to build. one at a time, bestie. 📦
  • --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. she's smart, she'll figure it out. 🧠✨
  • --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. a little home for your cache. 🗄️
  • --data-dir <data-dir> — Specifies the data directory,{n} in which the default user install tree resides{n} (e.g. ~/.local/share/lux). very demure, very mindful path. 🏡
  • --variables <variable> — Override config variables.{n} Example: lx -v "LUA=/path/to/lua" ... — see, it's easy. 🎛️
  • --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. we love a chatty queen. 🗣️
  • --no-progress — Don't print any progress bars or spinners. sometimes you just want peace and quiet. 🤫
  • --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 old news bestie, move 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). 🔐 like pls, protect yourself.
  • --timeout <seconds> — Timeout on network operations, in seconds.{n} 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. go off, no limits. 🚀
  • --no-luarc — Do not generate or update a .luarc.json file when building{n} a project. no extra files, no stress. 📝
  • --no-wrap-bin — Do not wrap Lua bin scripts. let them breathe. 🫧
  • --user-agent <USER_AGENT> — The user agent to set when making web requests. Default is "lux/<version>". introducing yourself to the internet, cute. 🌍
  • -h, --help — Print help (see a summary with '-h'). the classic "help me help you." 🙋‍♀️
  • [ARGS] — your args, your rules. 💫
ngl bestie, that's the whole page — every flag, every default, every possible value, all accounted for. no gatekeeping here. 💜

and that's a wrap! this page is from the General Commands Manual, filed under run, and honestly? iconic. this was lux-cli-run(1) — go run your project, periodt. 🧚‍♀️🌈⭐

📦 where this page comes from