📦 lux-cli

141 pages

L

lux-cli(1)A luxurious package manager for Lua✨
lux-cli-add(1)Add a dependency to the current project✨
lux-cli-build(1)Build/compile a project✨
lux-cli-check(1)[EXPERIMENTAL]{n} Type check the current project based on EmmyLua/LuaCATS annotations.{n} Respects `.emmyrc.json` and `.luarc.json` files in the project directory✨
lux-cli-config(1)Interact with the lux configuration✨
lux-cli-config-edit(1)Edit the current config file✨
lux-cli-config-help(1)Print this message or the help of the given subcommand(s)✨
lux-cli-config-help-edit(1)Edit the current config file✨
lux-cli-config-help-help(1)Print this message or the help of the given subcommand(s)✨
lux-cli-config-help-init(1)Initialise a new config file✨
lux-cli-config-help-show(1)Show the current config. This includes options picked up from CLI flags✨
lux-cli-config-init(1)Initialise a new config file✨
lux-cli-config-show(1)Show the current config. This includes options picked up from CLI flags✨
lux-cli-debug(1)Internal commands for debugging Lux itself✨
lux-cli-debug-fetch-remote(1)Fetch a remote rock from its RockSpec source✨
lux-cli-debug-help(1)Print this message or the help of the given subcommand(s)✨
lux-cli-debug-help-fetch-remote(1)Fetch a remote rock from its RockSpec source✨
lux-cli-debug-help-help(1)Print this message or the help of the given subcommand(s)✨
lux-cli-debug-help-project(1)View information about the current project✨
lux-cli-debug-help-toolchains(1)Check for available toolchains✨
lux-cli-debug-help-unpack(1)Unpack the contents of a rock✨
lux-cli-debug-help-unpack-remote(1)Download a .src.rock from luarocks.org and unpack it✨
lux-cli-debug-project(1)View information about the current project✨
lux-cli-debug-toolchains(1)Check for available toolchains✨
lux-cli-debug-unpack(1)Unpack the contents of a rock✨
lux-cli-debug-unpack-remote(1)Download a .src.rock from luarocks.org and unpack it✨
lux-cli-dist(1)Distribute a Lux project✨
lux-cli-dist-bin(1)Compile a Lux project, including its dependencies, into a single binary,{n} which runs on systems that do not have Lua installed.{n} Projects with native Lua modules are not single binaries: the…✨
lux-cli-dist-flat-archive(1)Distribute an archive of a flat install tree which includes all dependencies.{n} The resulting archive does not include the `etc` directory or build dependencies.{n} Unlike a Lux tree, dependency…✨
lux-cli-dist-help(1)Print this message or the help of the given subcommand(s)✨
lux-cli-dist-help-bin(1)Compile a Lux project, including its dependencies, into a single binary,{n} which runs on systems that do not have Lua installed.{n} Projects with native Lua modules are not single binaries: the…✨
lux-cli-dist-help-flat-archive(1)Distribute an archive of a flat install tree which includes all dependencies.{n} The resulting archive does not include the `etc` directory or build dependencies.{n} Unlike a Lux tree, dependency…✨
lux-cli-dist-help-help(1)Print this message or the help of the given subcommand(s)✨
lux-cli-doc(1)Show documentation for an installed rock✨
lux-cli-download(1)Download a specific rock file from a luarocks server✨
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✨
lux-cli-fmt(1)Formats the codebase with stylua✨
lux-cli-generate-lockfile(1)Generate a lockfile for the current project without installing its dependencies✨
lux-cli-generate-rockspec(1)Generate a rockspec file from a project✨
lux-cli-help(1)Print this message or the help of the given subcommand(s)✨
lux-cli-help-add(1)Add a dependency to the current project✨
lux-cli-help-build(1)Build/compile a project✨
lux-cli-help-check(1)[EXPERIMENTAL]{n} Type check the current project based on EmmyLua/LuaCATS annotations.{n} Respects `.emmyrc.json` and `.luarc.json` files in the project directory✨
lux-cli-help-config(1)Interact with the lux configuration✨
lux-cli-help-config-edit(1)Edit the current config file✨
lux-cli-help-config-init(1)Initialise a new config file✨
lux-cli-help-config-show(1)Show the current config. This includes options picked up from CLI flags✨
lux-cli-help-debug(1)Internal commands for debugging Lux itself✨
lux-cli-help-debug-fetch-remote(1)Fetch a remote rock from its RockSpec source✨
lux-cli-help-debug-project(1)View information about the current project✨
lux-cli-help-debug-toolchains(1)Check for available toolchains✨
lux-cli-help-debug-unpack(1)Unpack the contents of a rock✨
lux-cli-help-debug-unpack-remote(1)Download a .src.rock from luarocks.org and unpack it✨
lux-cli-help-dist(1)Distribute a Lux project✨
lux-cli-help-dist-bin(1)Compile a Lux project, including its dependencies, into a single binary,{n} which runs on systems that do not have Lua installed.{n} Projects with native Lua modules are not single binaries: the…✨
lux-cli-help-dist-flat-archive(1)Distribute an archive of a flat install tree which includes all dependencies.{n} The resulting archive does not include the `etc` directory or build dependencies.{n} Unlike a Lux tree, dependency…✨
lux-cli-help-doc(1)Show documentation for an installed rock✨
lux-cli-help-download(1)Download a specific rock file from a luarocks server✨
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✨
lux-cli-help-fmt(1)Formats the codebase with stylua✨
lux-cli-help-generate-lockfile(1)Generate a lockfile for the current project without installing its dependencies✨
lux-cli-help-generate-rockspec(1)Generate a rockspec file from a project✨
lux-cli-help-help(1)Print this message or the help of the given subcommand(s)✨
lux-cli-help-info(1)Show metadata for any rock✨
lux-cli-help-install(1)Install a rock for use on the system✨
lux-cli-help-install-lua(1)Manually install and manage Lua headers for various Lua versions✨
lux-cli-help-install-rockspec(1)Install a local rockspec for use on the system✨
lux-cli-help-lint(1)Lint the current project using `luacheck`✨
lux-cli-help-list(1)List currently installed rocks✨
lux-cli-help-lua(1)Run lua, with the `LUA_PATH` and `LUA_CPATH` set to the specified lux tree✨
lux-cli-help-new(1)Create a new Lua project✨
lux-cli-help-outdated(1)List outdated rocks✨
lux-cli-help-pack(1)Create a packed rock for distribution, packing sources or binaries✨
lux-cli-help-path(1)Return the currently configured package path✨
lux-cli-help-path-bin(1)Generate a `PATH` expression for `bin` executables in the lux tree. (not formatted as a shell command)✨
lux-cli-help-path-c(1)Generate a `LUA_CPATH` expression for native `lib` libraries in the lux tree. (not formatted as a shell command)✨
lux-cli-help-path-full(1)Generate an export statement for all paths (formatted as a shell command). [Default]✨
lux-cli-help-path-init(1)Generate a `LUA_INIT` expression for the lux loader. (not formatted as a shell command)✨
lux-cli-help-path-lua(1)Generate a `LUA_PATH` expression for `lua` libraries in the lux tree. (not formatted as a shell command)✨
lux-cli-help-pin(1)Pin an existing rock, preventing any updates to the package✨
lux-cli-help-purge(1)Remove all installed rocks from a tree✨
lux-cli-help-remove(1)Remove a rock from the current project's lux.toml dependencies✨
lux-cli-help-run(1)Run the current project with the provided arguments✨
lux-cli-help-search(1)Query the luarocks servers✨
lux-cli-help-shell(1)Spawns an interactive shell with PATH, LUA_PATH, LUA_CPATH and LUA_INIT set✨
lux-cli-help-sync(1)Synchronize the project tree with the current lux.toml,{n} ensuring all packages are installed correctly✨
lux-cli-help-test(1)Run the test suite in the current project directory.{n} Lux supports the following test backends, specified by the `[test]` table in the lux.toml:{n} {n} - busted:{n} {n}…✨
lux-cli-help-uninstall(1)Uninstall a rock from the system✨
lux-cli-help-unpin(1)Unpins an existing rock, allowing updates to alter the package✨
lux-cli-help-update(1)Updates all rocks in a project✨
lux-cli-help-upload(1)Generate a Lua rockspec for a Lux project and upload it to the public luarocks repository.{n} You can specify a source template for release and dev packages in the lux.toml.{n} {n} Example:{n} {n}…✨
lux-cli-help-util(1)Infrequently used commands such as for generating shell completions and man pages✨
lux-cli-help-util-completion(1)Generate autocompletion scripts for the shell.{n} Example: `lx completion zsh > ~/.zsh/completions/_lx`✨
lux-cli-help-util-man(1)Generate manpages✨
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{n} or the `[vendor_dir]` config option, Lux will fetch sources from…✨
lux-cli-help-which(1)Tell which file corresponds to a given module name✨
lux-cli-info(1)Show metadata for any rock✨
lux-cli-install(1)Install a rock for use on the system✨
lux-cli-install-lua(1)Manually install and manage Lua headers for various Lua versions✨
lux-cli-install-rockspec(1)Install a local rockspec for use on the system✨
lux-cli-lint(1)Lint the current project using `luacheck`✨
lux-cli-list(1)List currently installed rocks✨
lux-cli-lua(1)Run lua, with the `LUA_PATH` and `LUA_CPATH` set to the specified lux tree✨
lux-cli-new(1)Create a new Lua project✨
lux-cli-outdated(1)List outdated rocks✨
lux-cli-pack(1)Create a packed rock for distribution, packing sources or binaries✨
lux-cli-path(1)Return the currently configured package path✨
lux-cli-path-bin(1)Generate a `PATH` expression for `bin` executables in the lux tree. (not formatted as a shell command)✨
lux-cli-path-c(1)Generate a `LUA_CPATH` expression for native `lib` libraries in the lux tree. (not formatted as a shell command)✨
lux-cli-path-full(1)Generate an export statement for all paths (formatted as a shell command). [Default]✨
lux-cli-path-help(1)Print this message or the help of the given subcommand(s)✨
lux-cli-path-help-bin(1)Generate a `PATH` expression for `bin` executables in the lux tree. (not formatted as a shell command)✨
lux-cli-path-help-c(1)Generate a `LUA_CPATH` expression for native `lib` libraries in the lux tree. (not formatted as a shell command)✨
lux-cli-path-help-full(1)Generate an export statement for all paths (formatted as a shell command). [Default]✨
lux-cli-path-help-help(1)Print this message or the help of the given subcommand(s)✨
lux-cli-path-help-init(1)Generate a `LUA_INIT` expression for the lux loader. (not formatted as a shell command)✨
lux-cli-path-help-lua(1)Generate a `LUA_PATH` expression for `lua` libraries in the lux tree. (not formatted as a shell command)✨
lux-cli-path-init(1)Generate a `LUA_INIT` expression for the lux loader. (not formatted as a shell command)✨
lux-cli-path-lua(1)Generate a `LUA_PATH` expression for `lua` libraries in the lux tree. (not formatted as a shell command)✨
lux-cli-pin(1)Pin an existing rock, preventing any updates to the package✨
lux-cli-purge(1)Remove all installed rocks from a tree✨
lux-cli-remove(1)Remove a rock from the current project's lux.toml dependencies✨
lux-cli-run(1)Run the current project with the provided arguments✨
lux-cli-search(1)Query the luarocks servers✨
lux-cli-shell(1)Spawns an interactive shell with PATH, LUA_PATH, LUA_CPATH and LUA_INIT set✨
lux-cli-sync(1)Synchronize the project tree with the current lux.toml,{n} ensuring all packages are installed correctly✨
lux-cli-test(1)Run the test suite in the current project directory.{n} Lux supports the following test backends, specified by the `[test]` table in the lux.toml:{n} {n} - busted:{n} {n}…✨
lux-cli-uninstall(1)Uninstall a rock from the system✨
lux-cli-unpin(1)Unpins an existing rock, allowing updates to alter the package✨
lux-cli-update(1)Updates all rocks in a project✨
lux-cli-upload(1)Generate a Lua rockspec for a Lux project and upload it to the public luarocks repository.{n} You can specify a source template for release and dev packages in the lux.toml.{n} {n} Example:{n} {n}…✨
lux-cli-util(1)Infrequently used commands such as for generating shell completions and man pages✨
lux-cli-util-completion(1)Generate autocompletion scripts for the shell.{n} Example: `lx completion zsh > ~/.zsh/completions/_lx`✨
lux-cli-util-help(1)Print this message or the help of the given subcommand(s)✨
lux-cli-util-help-completion(1)Generate autocompletion scripts for the shell.{n} Example: `lx completion zsh > ~/.zsh/completions/_lx`✨
lux-cli-util-help-help(1)Print this message or the help of the given subcommand(s)✨
lux-cli-util-help-man(1)Generate manpages✨
lux-cli-util-man(1)Generate manpages✨
lux-cli-vendor(1)Vendor the dependencies of a project or RockSpec locally. When building or installing a package with the `--vendor-dir` option{n} or the `[vendor_dir]` config option, Lux will fetch sources from…✨
lux-cli-which(1)Tell which file corresponds to a given module name✨
lx(1)A luxurious package manager for Lua✨