cdsoft/req
1
0
Fork
You've already forked req
0
Req is a minimalist requirement management tool. It is inspired by tagref and adds the notions of document groups and relations.
  • Lua 95.4%
  • Makefile 2.5%
  • Shell 2.1%
Find a file
Christophe Delord 6afdbd7f8f cosmecis changes
2026年07月10日 18:15:25 +02:00
doc cosmecis changes 2026年07月10日 18:15:25 +02:00
src cosmecis changes 2026年07月10日 18:15:25 +02:00
tests rename test requirements to simplify req specification 2026年07月09日 19:47:52 +02:00
.gitignore Initial commit 2026年06月11日 22:13:47 +02:00
build.lua cosmecis changes 2026年07月10日 18:15:25 +02:00
LICENSE Initial commit 2026年06月11日 22:13:47 +02:00
README.md cosmecis changes 2026年07月10日 18:15:25 +02:00
req.toml rename test requirements to simplify req specification 2026年07月09日 19:47:52 +02:00

Req - Requirements engineering without the frills

Documentation Installation License Version

Req is a deliberately ultra-minimalist requirement management tool.

It is inspired by tagref and adds the notions of requirement sets and relations.

Note

Full documentation: doc/req.md

I wrote several tools (e.g. yreq) to deal with requirements. req is an attempt to replace tagref in the process described in Simplify your project documentation: Markdown + forge, that's all you need.

Support

If you like req (or LuaX) and are willing to support its development, please consider donating:

Donate using Liberapay Buy Me a Coffee at ko-fi.com

Installation

req requires LuaX.

# install req in ~/.local/bin and ~/.local/lib
$ git clone https://codeberg.org/cdsoft/req
$ cd req
$ bang && ninja install

or set $PREFIX to install req to a custom directory ($PREFIX/bin and $PREFIX/lib):

$ export PREFIX=/path # install req to /path/bin and /path/lib
$ git clone https://codeberg.org/cdsoft/req
$ cd req
$ bang && ninja install

This will install 2 files in $PREFIX/bin:

  1. $PREFIX/bin/req: req command line utility compiled with LuaX. It can be run without any dependency.
  2. $PREFIX/bin/req.lua: req.lua command line utility bundled with LuaX as a standalone Lua script. It requires a Lua 5.4 or 5.5 interpreter (e.g.: lua).

In case precompiled binaries are needed (GNU/Linux, MacOS, Windows), some can be found at cdelord.fr/pub. These archives contain req as well as some other softwares more or less related to LuaX.

Documentation

The full documentation is here: doc/req.md.

License

req is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
req is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with req. If not, see <https://www.gnu.org/licenses/>.
For further information about req you can visit
https://codeberg.org/cdsoft/req