lux-cli-help(1)

📦 version 0.48.0, in nixpkgs unstable

okay bestie, welcome to lux-cli-help(1) — the General Commands Manual page for the help command herself. Yes, the help command has a help page, and she’s lowkey iconic. 💅

🌸 NAME 🌸

lux-cli-help — print this message or the help of the given subcommand(s). That’s the job, and she does it with main character energy. ✨

✨ SYNOPSIS ✨

lux-cli help [subcommands]

That’s it: lux-cli + help + optional [subcommands], bestie. 🫶

🦋 DESCRIPTION 🦋

lux-cli-help prints this message, or it prints the help of the given subcommand(s). It’s the terminal version of “bestie, explain?” and no cap, she comes through. 💖

👑 SUBCOMMANDS 👑

Every one of these has her own page, and here’s the whole lineup in order — no skips, no “we’ll circle back,” periodt. 🎀

  • lux-cli-help-add(1) — Add a dependency to the current project. Dependency-wrangling, but make it cute. 💖
  • lux-cli-help-build(1) — Build/compile a project. Compile era. 🔥
  • lux-cli-help-check(1) — [EXPERIMENTAL] Type check the current project based on EmmyLua/LuaCATS annotations. Respects .emmyrc.json and .luarc.json files in the project directory. She’s experimental, so treat her like a testing-era icon. 🧪
  • lux-cli-help-config(1) — Interact with the lux configuration. Config chat. 🎀
  • lux-cli-help-debug(1) — Internal commands for debugging Lux itself. For debugging Lux herself. 🔍
  • lux-cli-help-dist(1) — Distribute a Lux project. Ship it. 🚀
  • lux-cli-help-doc(1) — Show documentation for an installed rock. Docs on deck. 📚
  • lux-cli-help-download(1) — Download a specific rock file from a luarocks server. Rock retrieval moment. 🪨
  • lux-cli-help-fmt(1) — Formats the codebase with stylua. Stylua said make it pretty. 💅
  • lux-cli-help-generate-rockspec(1) — Generate a rockspec file from a project. Rockspec generation. 📝
  • lux-cli-help-generate-lockfile(1) — Generate a lockfile for the current project without installing its dependencies. Lockfile only, no install. 🔒
  • lux-cli-help-info(1) — Show metadata for any rock. Metadata moment. ℹ️
  • lux-cli-help-install(1) — Install a rock for use on the system. System install. 🌍
  • lux-cli-help-install-rockspec(1) — Install a local rockspec for use on the system. Local rockspec, system-wide. 🏠
  • lux-cli-help-install-lua(1) — Manually install and manage Lua headers for various Lua versions. Lua headers on your terms. 🧠
  • lux-cli-help-lint(1) — Lint the current project using luacheck. Luacheck said be tidy. 🧹
  • lux-cli-help-list(1) — List currently installed rocks. The roster. 📋
  • lux-cli-help-lua(1) — Run lua, with the LUA_PATH and LUA_CPATH set to the specified lux tree. Lua with paths set. 🌙
  • lux-cli-help-new(1) — Create a new Lua project. New project, new era. ✨
  • lux-cli-help-outdated(1) — List outdated rocks. Who needs an update? 👀
  • lux-cli-help-pack(1) — Create a packed rock for distribution, packing sources or binaries. Pack it up, pack it in. 📦
  • lux-cli-help-path(1) — Return the currently configured package path. Path reveal. 🛤️
  • lux-cli-help-pin(1) — Pin an existing rock, preventing any updates to the package. Locked in, no updates. 📌
  • lux-cli-help-purge(1) — Remove all installed rocks from a tree. Purge the tree, dramatic but accurate. 🧹
  • lux-cli-help-remove(1) — Remove a rock from the current project’s lux.toml dependencies. Bye-bye dependency. 👋
  • lux-cli-help-run(1) — Run the current project with the provided arguments. Run it with args. 🏃
  • lux-cli-help-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. Command not found? She’ll install the package named after it. 😭
  • lux-cli-help-search(1) — Query the luarocks servers. Search the servers. 🔎
  • lux-cli-help-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:

busted: https://lunarmodules.github.io/busted/

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-help-uninstall(1) — Uninstall a rock from the system. Removal era. 🗑️
  • lux-cli-help-unpin(1) — Unpins an existing rock, allowing updates to alter the package. Unlocked and free. 🔓
  • lux-cli-help-update(1) — Updates all rocks in a project. Update the whole squad. 🔄
  • lux-cli-help-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. 🏷️

  • lux-cli-help-util(1) — Infrequently used commands such as for generating shell completions and man pages. The utility drawer, but make it useful. 🧰
  • lux-cli-help-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 sourcing, cute and practical. 🧺
  • lux-cli-help-which(1) — Tell which file corresponds to a given module name. Module-to-file detective work. 🕵️
  • lux-cli-help-shell(1) — Spawns an interactive shell with PATH, LUA_PATH, LUA_CPATH and LUA_INIT set. Shell but with the env vars set. 🐚
  • lux-cli-help-sync(1) — Synchronize the project tree with the current lux.toml, ensuring all packages are installed correctly. Sync era. 🔄
  • lux-cli-help-help(1) — Print this message or the help of the given subcommand(s). Help-ception, and she ate. 👑

cute sign-off: the footer bits are help and lux-cli-help(1), and there’s no date line visible — so we’re not inventing one, bestie. That’s the whole page, periodt. 💖🎀✨

📦 where this page comes from