Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,29 +37,35 @@ Designed for **always-green CI**, with strict checks and exit codes per risk lev

<!-- diff-risk:usage:start -->

### CLI usage
## 🚀 Usage (short aliases)

### CLI (recommended colorful table)
```bash
# Mostrar ayuda
poetry run diff-risk -h
# green panel (empty sample)
./bin/drt examples/sample_apv.empty.json

# Ejemplos de salida
poetry run diff-risk examples/sample_apv.json -f table --no-exit-by-risk
poetry run diff-risk examples/sample_apv.json -f json --no-exit-by-risk
poetry run diff-risk examples/sample_apv.json -f md -o _intel/report.md --no-exit-by-risk
# real example with findings
./bin/drt examples/sample_apv.json
```

**Exit codes**: `0=green`, `1=yellow`, `2=red` (usa `--no-exit-by-risk` para forzar `0`).

### Web (opcional)
Other formats:
```bash
./bin/drb examples/sample_apv.json # text bars
./bin/drj examples/sample_apv.json # JSON (CI/machines)
./bin/drmd examples/sample_apv.json _intel/report.md # Markdown file
```

Tip: to call aliases without `./bin/` temporarily:
```bash
poetry run diff-risk-web
# Abrir: http://127.0.0.1:8000
export PATH="$PWD/bin:$PATH"
drt examples/sample_apv.json
```

**Exit codes**: `0=green`, `1=yellow`, `2=red` (`--no-exit-by-risk` forces `0` for demos).

<!-- diff-risk:usage:end -->


> Sin cambios en tu sistema ni shell. Usa el proyecto como **app Python** con su comando **`diff-risk`** tras instalarlo.

```bash
Expand Down
4 changes: 4 additions & 0 deletions bin/drb
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env bash
set -euo pipefail
[ $# -ge 1 ] || { echo "Usage: drb <apv.json|json-string>"; exit 2; }
poetry run diff-risk "$1" -f bar --no-exit-by-risk
4 changes: 4 additions & 0 deletions bin/drj
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env bash
set -euo pipefail
[ $# -ge 1 ] || { echo "Usage: drj <apv.json|json-string>"; exit 2; }
poetry run diff-risk "$1" -f json --no-exit-by-risk
7 changes: 7 additions & 0 deletions bin/drm
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/usr/bin/env bash
set -euo pipefail
[ $# -ge 1 ] || { echo "Usage: drm <apv.json|json-string> [outfile.md]"; exit 2; }
out="${2:-_intel/report.md}"
mkdir -p "$(dirname "$out")"
poetry run diff-risk "$1" -f md -o "$out" --no-exit-by-risk
echo "Wrote $out"
7 changes: 7 additions & 0 deletions bin/drmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/usr/bin/env bash
set -euo pipefail
[ $# -ge 1 ] || { echo "Usage: drmd <apv.json|json-string> [outfile.md]"; exit 2; }
out="${2:-_intel/report.md}"
mkdir -p "$(dirname "$out")"
poetry run diff-risk "$1" -f md -o "$out" --no-exit-by-risk
echo "Wrote $out"
4 changes: 4 additions & 0 deletions bin/drt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env bash
set -euo pipefail
[ $# -ge 1 ] || { echo "Usage: drt <apv.json|json-string>"; exit 2; }
script -qfc "poetry run diff-risk \"$1\" -f table --no-exit-by-risk" /dev/null
3 changes: 3 additions & 0 deletions bin/drw
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/usr/bin/env bash
set -euo pipefail
poetry run diff-risk-web
Loading