Ster/Docs

ster errors

List, show and check every declared way a Ster functionality fails: what failed, why, what is shown, what fixes it, its code, exit status and test.

Invocation and purpose#

text
ster errors list [--markdown [--page <FILE>]]
ster errors show <FUNCTIONALITY>
ster errors check [--repository <DIR>] [--uncatalogued <FILE>] [--untested <FILE>]

list prints every functionality: the entries that start it, what it uses, and every cause it declares with its code, exit status, test and documentation anchor. --markdown prints the catalogue's documentation sections instead of JSON; --page limits them to the functionalities a page lists. show prints one functionality's causes — its id as list prints it, for example ster.workspace.import — and every cause it meets through the functionalities it uses.

check checks every declaration, every declared test the checkout --repository names holds, and every command no functionality names, and exits 1 on any finding. --uncatalogued and --untested name JSON lists of the commands still allowed to be uncatalogued and the declared tests not yet written; each may only shrink.