Skip to content

Commit b49c2af

Browse files
docs(readme): update usage section (CLI + web examples) (#14)
1 parent c8564f6 commit b49c2af

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,31 @@ Designed for **always-green CI**, with strict checks and exit codes per risk lev
3535

3636
## 🚀 Quick Start (end users)
3737

38+
<!-- diff-risk:usage:start -->
39+
40+
### CLI usage
41+
42+
```bash
43+
# Mostrar ayuda
44+
poetry run diff-risk -h
45+
46+
# Ejemplos de salida
47+
poetry run diff-risk examples/sample_apv.json -f table --no-exit-by-risk
48+
poetry run diff-risk examples/sample_apv.json -f json --no-exit-by-risk
49+
poetry run diff-risk examples/sample_apv.json -f md -o _intel/report.md --no-exit-by-risk
50+
```
51+
52+
**Exit codes**: `0=green`, `1=yellow`, `2=red` (usa `--no-exit-by-risk` para forzar `0`).
53+
54+
### Web (opcional)
55+
56+
```bash
57+
poetry run diff-risk-web
58+
# Abrir: http://127.0.0.1:8000
59+
```
60+
61+
<!-- diff-risk:usage:end -->
62+
3863
> Sin cambios en tu sistema ni shell. Usa el proyecto como **app Python** con su comando **`diff-risk`** tras instalarlo.
3964
4065
```bash

0 commit comments

Comments
 (0)