lux-lib

Crates.io	lux-lib
lib.rs	lux-lib
version	0.10.0
source	src
created_at	2025-02-18 21:27:16.961657+00
updated_at	2025-06-17 10:36:16.414728+00
description	Library for the lux package manager for Lua
homepage	https://nvim-neorocks.github.io
repository	https://github.com/nvim-neorocks/lux
max_upload_size
id	1560479
size	979,255

lux (github:nvim-neorocks:lux)

documentation

README

Lux

A luxurious package manager for Lua.

Key Features • How To Use • Comparison with Luarocks • Related Projects • Contributing

:star2: Key Features

Create and manage Lua projects
- Easily manage dependencies, build steps and more through the lux.toml file.
Parallel builds and installs :rocket:
Add/remove dependencies with simple CLI commands
Automatic generation of rockspecs
- Say goodbye to managing 10 different rockspec files in your source code :tada:
Integrated code formatting via lx fmt
- Powered by stylua.
Easily specify compatible Lua versions
- Lux will take care of Lua header installation automatically
- Forget about users complaining they have the wrong Lua headers installed on their system
Automatic code linting via lx check
- Powered by luacheck.
Powerful lockfile support
- Makes for fully reproducible developer environments.
- Makes Lux easy to integrate with Nix!
Fully compatible
- Works with existing luarocks packages.
- Have a complex rockspec that you don't want to rewrite to TOML? No problem! Lux allows the creation of an extra.rockspec file, everything just works.
- Have a very complex build script? Lux can shell out to luarocks if it knows it has to preserve maximum compatibility.

[!WARNING]

Lux, while generally functional, is a work in progress and does not have a 1.0 release yet.

:gear: How To Use

Feel free to consult the documentation on how to get started with Lux!

It features a tutorial and several guides to make you good at managing Lua projects.

:bar_chart: Comparison with `luarocks`

As this project is still a work in progress, some luarocks features have not been (fully) implemented yet. On the other hand, lux has some features that are not present in luarocks.

The following table provides a brief comparison:

	lux	luarocks v3.11.1
project format	TOML / Lua	Lua
add/remove dependencies	:white_check_mark:	:x:
parallel builds/installs	:white_check_mark:	:x:
proper lockfile support with integrity checks	:white_check_mark:	:x: (basic, dependency versions only)
run tests with busted	:white_check_mark:	:white_check_mark:
linting with luacheck	:white_check_mark:	:x:
code formatting with stylua	:white_check_mark:	:x:
automatic lua detection/installation	:white_check_mark:	:x:
default build specs	:white_check_mark:	:white_check_mark:
custom build backends	:white_check_mark:¹	:white_check_mark:
`rust-mlua` build spec	:white_check_mark: (builtin)	:white_check_mark: (external build backend)
`treesitter-parser` build spec	:white_check_mark: (builtin)	:white_check_mark: (external build backend)
install pre-built binary rocks	:white_check_mark:	:white_check_mark:
install multiple packages with a single command	:white_check_mark:	:x:
install packages using version constraints	:white_check_mark:	:x:
auto-detect external dependencies and Lua headers with `pkg-config`	:white_check_mark:	:x:
resolve multiple versions of the same dependency at runtime	:white_check_mark:	:white_check_mark:
pack and upload pre-built binary rocks	:white_check_mark:	:white_check_mark:
luarocks.org manifest namespaces	:white_check_mark:	:white_check_mark:
luarocks.org dev packages	:white_check_mark:	:white_check_mark:
versioning	SemVer²	arbitrary
rockspecs with CVS/Mercurial/SVN/SSCM sources	:x: (YAGNI³)	:white_check_mark:
static type checking	:x: (planned)	:x:
git dependencies in local projects	:white_check_mark:	:x:

:package: Packages

Lux includes the following packages and libraries:

lux-cli: The main CLI for interacting with projects and installing Lua packages from the command line.
lux-lua: The Lux Lua API, which provides:
- lux.loader for resolving dependencies on require at runtime.
- A work-in-progress API for embedding Lux into Lua applications. We provide builds of lux-lua for Lua 5.1, 5.2, 5.3, 5.4 and Luajit. lux-cli uses lux-lua for commands like lx lua, lx run and lx path.
lux-lib: The Lux library for Rust. A dependency of lux-cli and lux-lua.

[!NOTE]

We do not yet provide a way to install lux-lua as a Lua library using Lux. See #663. Lux can detect a lux-lua installation using pkg-config or via the LUX_LIB_DIR environment variable.

:wrench: Building from source

Dependencies:

openssl
libgit2
gnupg, libgpg-error and gpgme (*nix only)
lua (optional, if building without the vendored-lua feature)

We recommend building with the vendored-lua feature enabled:

cargo build --features vendored-lua

You can build lux-lua for a given Lua version with:

cargo xtask51 dist-lua # lux-lua for Lua 5.1
cargo xtask52 dist-lua # for Lua 5.2
cargo xtask53 dist-lua # ...
cargo xtask54 dist-lua
cargo xtaskjit dist-lua

This will install lux-lua to target/dist/<lua>/lux.so and a pkg-config .pc file to target/dist/lib/lux-lua*.pc.

:snowflake: Nix flake

If you would like to use the latest version of lux with Nix, you can import our flake. It provides an overlay and packages for:

lux-cli: The Lux CLI package.
lux-lua51 The Lux Lua API for Lua 5.1
lux-lua52 The Lux Lua API for Lua 5.2
lux-lua53 The Lux Lua API for Lua 5.3
lux-lua54 The Lux Lua API for Lua 5.4
lux-luajit The Lux Lua API for Luajit

If you have a lux-lua build and pkg-config in a Nix devShell, Lux will auto-detect lux-lua.

:bulb: You may also like...

luarocks - The original Lua package manager
rocks.nvim - A Neovim plugin manager that uses luarocks under the hood, and will soon be undergoing a rewrite to use Lux instead.

:purple_heart: Credits

Credits go to the Luarocks team for maintaining luarocks and luarocks.org for as long as they have. Without their prior work Lux would not be possible.

:green_heart: Contributing

Contributions are more than welcome! See CONTRIBUTING.md for a guide.

:book: License

Lux is licensed under LGPL-3.0+.

Supported via a compatibility layer that uses luarocks as a backend. ↩
Mostly compatible with the luarocks version parser, which allows an arbitrary number of version components. To comply with SemVer, we treat anything after the third version component (except for the specrev) as a prerelease/build version. ↩
You Aren't Gonna Need It. ↩

Commit count: 811