Skip to content

Commit 003cb9a

Browse files
committed
docs: usage block + full usage guide
1 parent a7c817e commit 003cb9a

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/USAGE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Diff Risk Dashboard — Usage
2+
3+
## Short wrappers
4+
- `drt <apv.json | raw-json>`: tabla a color (TTY)
5+
- `drb <apv.json | raw-json>`: barras (logs)
6+
- `drj <apv.json | raw-json>`: JSON (CI)
7+
- `drmd <apv.json | raw-json>`: Markdown (stdout)
8+
9+
```bash
10+
drt examples/sample_apv.json
11+
drt '{"by_severity":{"CRITICAL":0,"HIGH":1,"MEDIUM":1,"LOW":1,"INFO":0}}'
12+
APV="/ruta/real/a/tu_apv.json"; drt "$APV"
13+
```
14+
15+
Agregar al PATH (opcional):
16+
```bash
17+
mkdir -p ~/.local/bin && ln -sf "$PWD/bin/"* ~/.local/bin/ && hash -r
18+
```
19+
20+
CLI crudo:
21+
```bash
22+
poetry run diff-risk <input> -f table|bar|json|md --no-exit-by-risk
23+
```

0 commit comments

Comments
 (0)