diff --git a/AUDIT.md b/AUDIT.md new file mode 100644 index 0000000..6968da1 --- /dev/null +++ b/AUDIT.md @@ -0,0 +1,42 @@ +# Audit — stigsentry + +Generated 2026-06-12 UTC. + +```json +{ + "repo": "stigsentry", + "parse_errors": [], + "tests_passed": 3, + "tests_failed": 0, + "tests_errored": 0, + "has_tests": true, + "pytest_tail": "... [100%]\n3 passed in 0.26s", + "package": "stigsentry", + "cli_version": "stigsentry 0.1.0", + "clean": true +} +``` + +## pytest +``` +... [100%] +3 passed in 0.26s +``` + +## CLI +``` +usage: stigsentry [-h] [--format {console,json,markdown,sarif,oscal}] + [--out OUT] [--fail-on {very_high,high,moderate,low,none}] + [--classification CLASSIFICATION] [-v] + [target] + +stigsentry — Cognis Digital · Military/IC ecosystem + +positional arguments: + target Path/target + +options: + -h, --help show this help message and exit + --format {console,json,markdown,sarif,oscal} + --out OUT Write output to file +``` diff --git a/README.md b/README.md index fe225b6..38a354d 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ These are emitted in JSON, SARIF, and the OSCAL skeleton. ```yaml - name: stigsentry scan run: | - pip install cognis-stigsentry + pip install "git+https://github.com/cognis-digital/stigsentry.git" stigsentry . --format=oscal --out=assessment-results.json --fail-on=high - name: Upload to eMASS/Xacta run: cognis-rmf-package import assessment-results.json @@ -80,3 +80,42 @@ These are emitted in JSON, SARIF, and the OSCAL skeleton. Apache-2.0 unless stated otherwise. See [the master index](../../MASTER-INDEX.md). + + +## Verification + +[![tests](https://img.shields.io/badge/tests-3%20passing-2ea44f.svg)](AUDIT.md) + +Every push is verified end-to-end. Latest audit (2026-06-12): + +```text +tests : 3 passed, 0 failed, 0 errored +compile : all modules parse +cli : stigsentry 0.1.0 +package : stigsentry +``` + +
CLI surface (--help) + +```text +usage: stigsentry [-h] [--format {console,json,markdown,sarif,oscal}] + [--out OUT] [--fail-on {very_high,high,moderate,low,none}] + [--classification CLASSIFICATION] [-v] + [target] + +stigsentry — Cognis Digital · Military/IC ecosystem + +positional arguments: + target Path/target + +options: + -h, --help show this help message and exit + --format {console,json,markdown,sarif,oscal} + --out OUT Write output to file +``` +
+ +Full machine-readable results: [`AUDIT.md`](AUDIT.md) · regenerate with `python -m stigsentry --help` + `pytest -q`. + +
↑ back to top
+