lux-cli-lua(1)

📦 version 0.48.0, in nixpkgs unstable

💅 bestie, it's lux-cli-lua(1) time 💅

this page lives in the General Commands Manual and it's all about running lua with the LUA_PATH and LUA_CPATH set to the specified lux tree. okay so, let's go. ✨

🌸 NAME 🌸

lux-cli-lua — Run lua, with the LUA_PATH and LUA_CPATH set to the specified lux tree. 💖

🦋 SYNOPSIS 🦋

here's the whole synopsis, copy-paste energy, exactly as the page gives it:

lux-cli lua [--lua] [--server] [--test] [--build] [--extra-servers]
[--namespace] [--no-loader] [--lua-dir] [--no-lock] [--lua-version]
[--only-deps] [-p|--package] [--tree] [--cache-dir] [--help]
[--data-dir] [--variables] [--profile] [--verbose] [--no-progress]
[--no-prompt] [--preset] [--nvim] [--no-tfa] [--timeout] [--max-jobs]
[--no-luarc] [--no-wrap-bin] [--user-agent] [ARGS]

💖 DESCRIPTION 💖

Run lua, with the LUA_PATH and LUA_CPATH set to the specified lux tree. that's the whole main-character mission, fr fr. 🫶

💅 OPTIONS 💅

  • --lua <LUA> — Path to the Lua interpreter to use. 💖
  • --server <server> — Fetch rocks/rockspecs from this server (takes priority over config file). 👑
  • --test — Add test dependencies to the environment. 🧪
  • --build — Add build dependencies to the environment. 🛠️
  • --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. 🦋
  • --no-loader — Disable the Lux loader. If a rock has conflicting transitive dependencies, disabling the Lux loader may result in the wrong modules being loaded. ⚠️
  • --lua-dir <prefix> — Specify the directory in which to install Lua if not found. 📁
  • --no-lock — Ignore the project's lockfile and don't create one. 🔓
  • --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.
  • --only-deps — Build only the dependencies. 🧱
  • -p, --package <PACKAGE> — Package to build. 📦
  • --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. 🗂️
  • --help — Print help. 🆘
  • --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>". 🕵️
  • [ARGS] — Arguments to pass to Lua. See lua -h. 🚀

that's the whole lux-cli-lua(1) page, bestie — footer sign-off time: source/version lua, page lux-cli-lua(1), General Commands Manual date slot, and all the vibes. periodt. 💖✨

📦 where this page comes from