This article has multiple issues. Please help improve it or discuss these issues on the talk page. (Learn how and when to remove these messages)
|
LuaRocks is a package manager for the Lua programming language that provides a standard format for distributing Lua modules (in a self-contained format called a "rock"), a tool designed to easily manage the installation of rocks, and a server for distributing them. While not included with the Lua distribution, it has been called the "de facto package manager for community-contributed Lua modules".[1]
| Original author(s) | Hisham Muhammad |
|---|---|
| Developer(s) | Hisham Muhammad, et al. |
| Initial release | August 9, 2007 |
| Stable release | 3.10.0
/ February 27, 2024 |
| Repository | |
| Written in | Lua |
| Operating system | Linux, macOS, Windows (Cygwin), Solaris, OpenBSD, NetBSD, FreeBSD |
| Type | Package manager |
| License | MIT License |
| Website | luarocks |
The interface for LuaRocks is a command-line tool called luarocks which can install libraries and manage Lua rocks.[2] LuaRocks optionally integrates with Lua run-time loader to help find and load installed rocks while managing version dependencies. Though it is possible to use a private LuaRocks repository, the public repository is most commonly used for rocks management. As of December 2016, there are over 1,500 rocks in the public repository.[3]
The public repository helps users find rocks, resolve dependencies and install them. LuaRocks is compatible with Lua versions 5.1, 5.2 and 5.3, as well as LuaJIT.
History
editDevelopment on LuaRocks was started in 2006 by Hisham Muhammad and was released to the public on August 9, 2007.[4]
In 2015, the public repository moved from a static page curated by the tool's developer to a new server written in MoonScript by Leaf Corcoran. Also, LuaRocks development was moved to GitHub in 2010.
Portability
editLuaRocks is written in Lua itself, and it is cross-platform. It is available in all major Linux distributions. However, since distribution packages often lag behind the latest release installing the latest release is recommended. When installed from the upstream tarball, LuaRocks can upgrade itself on Unix systems.
For Windows, LuaRocks distributes a package file including LuaRocks, Lua 5.1 and required utilities that are missing in a typical Windows system. The Windows package supports both Microsoft Visual Studio and MinGW compiler suites. For running on Cygwin, the Unix package should be used.
On macOS, LuaRocks is included with the Lua package of the Homebrew package manager. The Unix tarball can also be installed directly on macOS.
LuaRocks has also been reported to work on FreeBSD, OpenBSD, NetBSD and Solaris.[4]
Due to installation issues (permissions needed for system installation, lagging system packages, etc.), there is hererocks, a package available at the Python Package Index that can be installed via pip and provides installations of Lua and LuaRocks into a local directory upon demand.[5]
Projects using LuaRocks
editLuaRocks allows installing Lua modules to standard Lua paths as well as to customized locations. For this reason, it is possible to use it to install extensions to any project that uses standard Lua modules, such as the Awesome window manager. Some projects, however, adopted LuaRocks as their recommended solution for managing extensions, integrating it and in some cases, maintaining their own repository of project-specific rocks. Some projects that use LuaRocks in this fashion are:
- Kong Gateway - an open-source API gateway. Kong uses LuaRocks for building the gateway and supports installing plugins and additional rocks.[6]
- Torch - Torch, a framework for machine learning, uses LuaRocks for managing its modules. Torch uses its own rocks repository.[7]
- Tarantool - the Tarantool database uses LuaRocks for managing its extensions.[8]
See also
editReferences
edit- ^ "Lua: Not Your Average Scripting Language". ActiveState Blog. 22 November 2016. Retrieved 9 January 2017.
- ^ "Using LuaRocks". LuaRocks wiki. Retrieved 30 December 2016.
- ^ "LuaRocks Stats". LuaRocks.org. Retrieved 30 December 2016.
- ^ a b "Release history". LuaRocks wiki.
- ^ "hererocks". PyPI. Retrieved 2022-05-18.
- ^ "(un)Installing your plugin". Kong Gateway - Kong Docs. Retrieved 27 February 2024.
- ^ "Rocks for Torch". Torch rocks repository. Retrieved 30 December 2016.
- ^ "Tarantool Rocks". Tarantool. Retrieved 30 December 2016.