Documentation

Bonnie configuration files are self-documenting, which means you don't have to delve into the weeds of the actual bonnie.toml to use someone else's config (or your own after six months). You can see this documentation for your config file by running bonnie help (help is a reserved command). You can also add the name of a command after help to get information about just that command (and any of its subcommands). If you want generic help about Bonnie itself, run bonnie -h/bonnie --help instead.

Commands will automatically be documented relatively intuitively in the following format:

<ENV_VAR> <ENV_VAR_2> command_name <arg1> <arg2>

For commands that support ordered subcommands, (ordered) will be added at the end as well.

However, this doesn't provide much useful information about what commands actually do, which is up to you to provide through the .desc property, which sits next to .cmd. For example:

test.cmd = "echo Test"
test.desc = "some documentation"

Your documentation will be printed next to a command specification as above, so it should probably start in lower case. Beyond that, write whatever's useful to you and anyone else using the configuration!