Exit codes and environment
What inkdex and inkdex-vuln return, and the environment variables they read.
| Code | Meaning |
|---|
0 | Success, results found. |
1 | No results. |
2 | Usage error, missing index, bad path, or no valid license. |
3 | Internal error. |
| Code | Meaning |
|---|
0 | The scan ran (findings or not). |
1 | --fail-on was given (or fail_on is set in .inkdex-vuln.toml) and a finding left after the filters and the ignores is at least that severe. |
2 | The scan could not run: no index, bad path, no valid license. |
1 when the head introduces a new unsanitized flow, 0 otherwise.
| Variable | What it does |
|---|
INKDEX_TOKEN | A CI token: the license credential for pipelines. |
INKDEX_KEY | Your license key, instead of inkdex license activate. |
INKDEX_HOME | Where the license is kept (default ~/.config/inkdex). |
NO_COLOR | Plain output: no colours, no progress display. |
CI | Set by most CI systems: turns the progress display off. |
RUST_LOG | Debug logging on stderr (RUST_LOG=inkdex=debug), for support requests. |
Every command accepts:
| Option | What it does |
|---|
-C DIR | Run as if started in DIR. |
--index PATH | Use the .inkdex/ index at PATH. |
--json / --jsonl | One JSON document / one JSON object per line. |
-q, --quiet | Print nothing; rely on the exit code. |
--at REF | Read a snapshot: worktree, a sha, HEAD~2, a tag. |
