Skip to content

Commit

Permalink
docs: add documentation to CLI instalation
Browse files Browse the repository at this point in the history
  • Loading branch information
thgomes committed Sep 13, 2024
1 parent 1aa7e34 commit 003ce95
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/manual-de-instalacao/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# CLI

Faça download do pacote do MeasureSoftGram no PyPi através do comando:
```bash
pip install msgram
```

Após a instalação do pacote execute o comando abaixo para verificar se o msgram foi instalado.
```bash
msgram --help
```

Caso os seguintes textos forem exibidos na tela, significa que o measure foi instalado com sucesso na sua máquina e está pronto para uso.
```bash
usage: msgram [-h] {init,list,extract,calculate,norm_diff,diff} ...

Command line interface for measuresoftgram

options:
-h, --help show this help message and exit

subcommands:
{init,list,extract,calculate,norm_diff,diff}
sub-command help
init Create a init file `.measuresoftgram` with your default organization, product and repositories
list Listing configurations parameters.
extract Extract supported metrics
calculate Calculates all entities
norm_diff Calculate the norm difference between the planned metrics and the developed.
diff Calculates differences between planned and developed values. Returns the result vector.

Thanks for using msgram!
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,6 @@ nav:
- Service: manual-de-instalacao/service.md
- Front: manual-de-instalacao/front.md
- Action: manual-de-instalacao/action.md
- CLI: manual-de-instalacao/cli.md

- Post-Mortem: post-mortem/post-mortem.md

0 comments on commit 003ce95

Please sign in to comment.