Welcome

Installing LuaRocks

• Download
  • Installation instructions for Unix
  • Installation instructions for macOS
  • Installation instructions for Windows

Using LuaRocks

• Using LuaRocks
• Types of rocks
• Rocks repositories
• Browse rocks
• Dependencies
  • Paths and external dependencies
  • Namespaces
  • Pinning versions with a lock file
• Community support and more resources

Creating rocks

• Creating a rock
• Platform overrides
• Platform-agnostic external dependencies
• Recommended practices for Makefiles
  • Creating a Makefile that plays nice with LuaRocks
• Creating LuaRocks with GNU autotools

Advanced topics

• LuaRocks through a proxy
• Embedding LuaRocks in an application
• Integrating distro modules with LuaRocks

LuaRocks servers

• Creating a local LuaRocks server
• Hosting binary rocks

Reference

• File formats

  • Config file format
  • Rock file format
  • Rockspec format
  • Rock manifest file format
  • Manifest file format

• File locations

• Command-line interface

  • luarocks

    • luarocks build
    • luarocks config
    • luarocks doc
    • luarocks download
    • luarocks help
    • luarocks install
    • luarocks lint
    • luarocks list
    • luarocks make
    • luarocks new_version
    • luarocks pack
    • luarocks path
    • luarocks purge
    • luarocks remove
    • luarocks search
    • luarocks show
    • luarocks test
    • luarocks unpack
    • luarocks upload
    • luarocks write_rockspec

  • luarocks-admin

    • luarocks-admin add
    • luarocks-admin help
    • luarocks-admin make manifest
    • luarocks-admin refresh cache
    • luarocks-admin remove

• Release history

Credits

License

Index