lux-cli(1)

📦 version 0.48.0, in nixpkgs unstable

✨ LUX-CLI(1) — The Most Iconic Package Manager for Lua 💅

Okay bestie, listen up. This is the manual for lux-cli(1) — yeah, the luxurious package manager for Lua. It's giving main character energy, and you're about to understand every single flag, option, and subcommand. No cap. Let's go. 🚀

🌸 NAME 🌸

lux-cli — A luxurious package manager for Lua. Periodt. 💖

🦋 SYNOPSIS 🦋

lux-cli [--dev] [--server] [--extra-servers] [--namespace] [--lua-dir]
[--lua-version] [--tree] [--cache-dir] [--no-manifest-cache]
[--data-dir] [--vendor-dir] [--variables] [--profile] [--verbose]
[--no-progress] [--no-prompt] [--preset] [--nvim] [--no-tfa] [--timeout]
[--max-jobs] [--no-luarc] [--no-wrap-bin] [--user-agent] [-h|--help]
[-V|--version] <subcommands>

🌈 DESCRIPTION 🌈

A luxurious package manager for Lua. It's literally that simple. Lux handles your rocks, your rockspecs, your projects, your trees — all of it. She's the moment. 💅

🎀 OPTIONS 🎀

Okay so here's the full rundown of every flag. Don't skip a single one — they all matter, iykyk.

  • --dev — Enables the sub-repositories in luarocks servers for rockspecs of in-development versions. Like, the pre-release vibes. 🔥
  • --server <server> — Fetches rocks/rockspecs from this server. Takes priority over the config file. You're in charge, bestie. 👑
  • --extra-servers <extra-server> — Fetches rocks/rockspecs from these servers in addition to the main server. Overrides any entries in the config file. More sources, more slay. ✨
  • --namespace <namespace> — Specifies the luarocks server namespace to use. Gotta keep your namespaces organized. 🎯
  • --lua-dir <prefix> — Specifies the directory in which to install Lua if not found. Like a little home for your Lua installation. 🏠
  • --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. It's giving organizational queen. 🌳
  • --cache-dir <cache-dir> — Specifies the cache directory, e.g. for luarocks manifests. Gotta cache 'em all. 💾
  • --no-manifest-cache — Disables the precomputed manifest cache. No cache for you. 🙅‍♀️
  • --data-dir <data-dir> — Specifies the data directory, in which the default user install tree resides (e.g. ~/.local/share/lux). That's where your stuff lives. 📂
  • --vendor-dir <vendor-dir> — Specifies a directory with locally vendored sources and RockSpecs. When building or installing a package with this flag, Lux will fetch sources from the <vendor-dir> instead of from a remote server. Local love. 🏡
  • --variables <variable> — Override config variables. Example: lx -v "LUA=/path/to/lua" .... Because sometimes you need to tweak things. 🔧
  • --profile <profile> — The build profile to use when compiling packages. Default: release.

Possible values:

  • release
  • dev
  • --verbose — Displays verbose output of commands executed, enabling DEBUG logs. To enable TRACE logs, set RUST_LOG=trace. Maximum spill-the-tea energy. 🗣️
  • --no-progress — Don't print any progress bars or spinners. Just silence. Peaceful. 🧘‍♀️
  • --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. (RIP to the old way, but we move. 💀)
  • --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. > Security matters, bestie. Don't skip 2FA unless you absolutely have to. 🔐
  • --timeout <seconds> — Timeout on network operations, in seconds. 0 means no timeout (wait forever). Default is 30. Ain't nobody got time to wait forever. ⏳
  • --max-jobs <MAX_JOBS> — Maximum buffer size for parallel jobs, such as downloading rockspecs and installing rocks. 0 means no limit. Default is 0. Parallel processing queen. ⚡
  • --no-luarc — Do not generate or update a .luarc.json file when building a project. No luarc for you. 📝
  • --no-wrap-bin — Do not wrap Lua bin scripts. Leave 'em unwrapped. 🎁
  • --user-agent <USER_AGENT> — The user agent to set when making web requests. Default is "lux/<version>". Gotta identify yourself online. 🕵️‍♀️
  • -h, --help — Print help (see a summary with -h). Your guide to everything. 📖
  • -V, --version — Print version. Know your Lux. 💖

🌟 SUBCOMMANDS 🌟

Here's where the real magic happens. Every subcommand is its own little icon. Let's break 'em down. 🫶

  • lux-cli-add(1) — Add a dependency to the current project. 💕
  • lux-cli-build(1) — Build/compile a project. 🔨
  • lux-cli-check(1) — [EXPERIMENTAL] Type check the current project based on EmmyLua/LuaCATS annotations. Respects .emmyrc.json and .luarc.json files in the project directory. Type safety, slay. 🧠
  • lux-cli-config(1) — Interact with the lux configuration. ⚙️
  • lux-cli-debug(1) — Internal commands for debugging Lux itself. For when you need to look under the hood. 🔍
  • lux-cli-dist(1) — Distribute a Lux project. Share the love. 📦
  • lux-cli-doc(1) — Show documentation for an installed rock. Knowledge is power. 📚
  • lux-cli-download(1) — Download a specific rock file from a luarocks server. Get that rock. 🪨
  • lux-cli-fmt(1) — Formats the codebase with stylua. Pretty code, pretty vibes. ✨
  • lux-cli-generate-rockspec(1) — Generate a rockspec file from a project. Rockspec magic. 🪄
  • lux-cli-generate-lockfile(1) — Generate a lockfile for the current project without installing its dependencies. Lock it in. 🔒
  • lux-cli-info(1) — Show metadata for any rock. The tea on your rocks. ☕
  • lux-cli-install(1) — Install a rock for use on the system. System-wide slay. 🖥️
  • lux-cli-install-rockspec(1) — Install a local rockspec for use on the system. Local love. 🏠
  • lux-cli-install-lua(1) — Manually install and manage Lua headers for various Lua versions. Headers, headers, headers. 📋
  • lux-cli-lint(1) — Lint the current project using luacheck. Clean code = clean conscience. 🧼
  • lux-cli-list(1) — List currently installed rocks. See what you've got. 📋
  • lux-cli-lua(1) — Run lua, with the LUA_PATH and LUA_CPATH set to the specified lux tree. Lua, but make it lux. 🌙
  • lux-cli-new(1) — Create a new Lua project. Fresh start, new project. 🌱
  • lux-cli-outdated(1) — List outdated rocks. Time to update, bestie. ⏰
  • lux-cli-pack(1) — Create a packed rock for distribution, packing sources or binaries. Pack it up, pack it in. 🎒
  • lux-cli-path(1) — Return the currently configured package path. Where the packages at? 🗺️
  • lux-cli-pin(1) — Pin an existing rock, preventing any updates to the package. Locked in place. 📌
  • lux-cli-purge(1) — Remove all installed rocks from a tree. Clean slate. 🧹
  • lux-cli-remove(1) — Remove a rock from the current project's lux.toml dependencies. Bye Felicia. 👋
  • lux-cli-run(1) — Run the current project with the provided arguments. Run it. 🏃‍♀️
  • lux-cli-exec(1) — Execute a command that has been installed with lux. If the command is not found, a package named after the command will be installed. Automatic. ✨
  • lux-cli-search(1) — Query the luarocks servers. Search far and wide. 🔎
  • lux-cli-test(1) — Run the test suite in the current project directory. Lux supports the following test backends, specified by the [test] table in the lux.toml:

Example:

[test]
type = "busted"
flags = [ ] # Optional CLI flags to pass to busted

lx test will default to using busted if no test backend is specified and:

  • there is a .busted file in the project root
  • or busted is one of the test_dependencies.
  • busted-nlua: A build backend for running busted tests with Neovim as the Lua interpreter. Used for testing Neovim plugins.

Example:

[test]
type = "busted-nlua"
flags = [ ] # Optional CLI flags to pass to busted

lx test will default to using busted-nlua if no test backend is specified and:

  • there is a .busted file in the project root
  • or busted and nlua are test_dependencies.
  • command: Name/file name of a shell command that will run the test suite.

Example:

[test]
type = "command"
command = "make"
flags = [ "test" ]
  • script: Relative path to a Lua script that will run the test suite.

Example:

[test]
type = "script"
script = "tests.lua" # Expects a tests.lua file in the project root
flags = [ ] # Optional arguments passed to the test script
  • lux-cli-uninstall(1) — Uninstall a rock from the system. Remove it. 🗑️
  • lux-cli-unpin(1) — Unpins an existing rock, allowing updates to alter the package. Free it. 🕊️
  • lux-cli-update(1) — Updates all rocks in a project. Refresh. 🔄
  • lux-cli-upload(1) — Generate a Lua rockspec for a Lux project and upload it to the public luarocks repository. You can specify a source template for release and dev packages in the lux.toml.

Example:

[source]
url = "https://host.com/owner/$(PACKAGE)/refs/tags/$(REF).zip"
dev = "git+https://host.com/owner/$(PACKAGE).git"

You can use the following variables in the source template:

  • $(PACKAGE): The package name.
  • $(VERSION): The package version.
  • $(REF): The git tag or revision (if in a git repository).
  • You may also specify environment variables with $(<VAR_NAME>).

If the version is not set in the lux.toml, lux will search the current commit for SemVer tags and if found, will use it to generate the package version. Upload queen. 👑

  • lux-cli-util(1) — Infrequently used commands such as for generating shell completions and man pages. The utility belt. 🛠️
  • lux-cli-vendor(1) — Vendor the dependencies of a project or RockSpec locally. When building or installing a package with the --vendor-dir option or the [vendor_dir] config option, Lux will fetch sources from the <vendor-dir> instead of from a remote server. Local dependencies, local vibes. 🏡
  • lux-cli-which(1) — Tell which file corresponds to a given module name. Where's that module? 🗂️
  • lux-cli-shell(1) — Spawns an interactive shell with PATH, LUA_PATH, LUA_CPATH and LUA_INIT set. Shell time. 🐚
  • lux-cli-sync(1) — Synchronize the project tree with the current lux.toml, ensuring all packages are installed correctly. Sync it up. 🔄
  • lux-cli-help(1) — Print this message or the help of the given subcommand(s). Help is always here. 🆘

💜 VERSION 💜

v0.48.0 — that's the version, bestie. Remember it. 💖

🫶 AUTHORS 🫶

  • vhyrro <vhyrro@gmail.com>
  • mrcjkb <marc@jakobi.dev>

Legends, both of them. 👑

Okay that's the whole manual! You're now fully caught up on lux-cli(1). This was lux-cli 0.48.0, manual page lux-cli(1). Stay luxurious, bestie! 💅✨🎀

📦 where this page comes from