Skip to content

5 REQ cli

Jump to bottom
Manuel Hatzl edited this page Dec 11, 2024 · 2 revisions

cli: Control mantra via CLI

It must be possible to control all features of mantra via CLI, because this helps with integration into CI/CD workflows.

cli.collect: Central command to collect all related information

A central collect command must be available that collects all information needed in mantra.

Implementation Details:

A central mantra.toml file located in the folder the command is executed in should be used for configuration.

cli.collect.metadata: Collect project metadata

It should be possible to specify metadata such as the project name, version, and link in mantra.toml, because this information does not frequently change, but is needed by some CLI commands such as report.

cli.report: Command to create (custom) reports

  • Parents: cli, report

A report command must be available to create (custom) reports via CLI.

cli.validate: Command to validate collected data

  • Parents: cli, analyze.validate

A validate command must be available to validate collected date via CLI.

cli.query: Command to analyze collected data

  • Parents: cli, analyze.custom

A query command must be available to analyze collected date via CLI.

Please create an issue if you found any spelling mistakes.
You may also create an issue if you think the content of this wiki should be improved.

Note: This wiki is managed in its own repository. Any commits made using the edit button will be overwritten.

Note: Issues for the wiki are handled in the mantra repository, but pull requests for the wiki are handled in the mantra-wiki repository.

This wiki is MIT licensed, and works together with mantra.

Clone this wiki locally