lubyk logo

Lubyk documentation

Lubyk utility module Build Status

Currently, this module contains a documentation generator and testing facilities.

Fork me on GitHub

MIT license © Gaspard Bucher 2014.


With luarocks:

$ luarocks install lut

.VERSION = '1.2.2'

Current version of 'lut' respecting semantic versioning.

Library dependencies


'lua >= 5.1, < 5.4'

Compatible with Lua 5.1 to 5.3 and LuaJIT

'lub >= 1.0.3, < 2'

Uses Lubyk base library



This class helps setup CMake and luarocks configuration files from a single configuration table and some conventions regarding file location.


lut.Doc parses lua comments and extracts the documentation from these comments. For usage, see


This class helps setup files and folders for a new lua project with tests, pure Lua files and C++ code.


The test suite is used to declare tests and group them by class or module.