audit-labs/audit-tools

A collection of scripts, queries, and other goodies you can use in an audit.

clone: git clone https://gitbay.org/audit-labs/audit-tools.git

31b46e63560ece1327b9587cdb2a8518361959b0

verified · cmc

author: Christian Cleberg <hello@cleberg.net> · 2026-07-29T04:58:14Z

chore: remove ineffective sonar config, add TUI screenshots to docs

- Remove sonar-project.properties. SonarCloud runs in Automatic Analysis
  (Autoscan) mode, which does not honor the issue.ignore rules in that file, so
  it had no effect. Rule suppressions are handled in code where needed.
- Add docs/screenshots/ (platform menu, check selection, live run) and show
  them in the root README and tui/README so the interactive app is visible up
  front.

 README.org                  |  11 +++++++++++
 docs/screenshots/checks.png | Bin 0 -> 177017 bytes
 docs/screenshots/menu.png   | Bin 0 -> 106034 bytes
 docs/screenshots/run.png    | Bin 0 -> 179677 bytes
 sonar-project.properties    |  15 ---------------
 tui/README.md               |   4 ++++
 6 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/README.org b/README.org
index 0f1f137..b7475f1 100644
--- a/README.org
+++ b/README.org
@@ -7,6 +7,12 @@ automating common audit procedures and analyses.
 This repository includes practical examples that can be used as-is or adapted to
 specific audit environments.
 
+It also ships an interactive terminal UI (=audit_tui.py=) that walks you through
+running an audit against GitHub, GitLab, or AWS — pick a platform, enter
+connection details, choose which checks to run, and watch live progress.
+
+[[./docs/screenshots/menu.png]]
+
 ** Contents
 
 | Directory            | Description                                                                  |
@@ -66,6 +72,11 @@ To pick a platform and be walked through an audit interactively:
 python audit_tui.py
 #+end_src
 
+Each run writes the same package the platform's =audit.py= produces — one CSV per
+check plus a summary — with a progress bar and per-check results:
+
+[[./docs/screenshots/run.png]]
+
 See =tui/README.md= for details. GitHub, GitLab, and AWS are supported.
 
 ** Contributing
diff --git a/docs/screenshots/checks.png b/docs/screenshots/checks.png
new file mode 100644
index 0000000..474d9e1
Binary files /dev/null and b/docs/screenshots/checks.png differ
diff --git a/docs/screenshots/menu.png b/docs/screenshots/menu.png
new file mode 100644
index 0000000..04e923d
Binary files /dev/null and b/docs/screenshots/menu.png differ
diff --git a/docs/screenshots/run.png b/docs/screenshots/run.png
new file mode 100644
index 0000000..22b62de
Binary files /dev/null and b/docs/screenshots/run.png differ
diff --git a/sonar-project.properties b/sonar-project.properties
deleted file mode 100644
index 8f3f348..0000000
--- a/sonar-project.properties
+++ /dev/null
@@ -1,15 +0,0 @@
-# SonarCloud configuration (Automatic Analysis / Autoscan).
-#
-# projectKey and organization are intentionally omitted — they are bound
-# automatically by the GitHub integration, and setting them here can disable
-# Automatic Analysis.
-
-# Suppress python:S1172 (unused function parameter) on the collector packages.
-# Collectors share a uniform (id, cfg, cache) signature so the audit runner can
-# dispatch every check the same way. Some collectors legitimately use only part
-# of that signature — per-project collectors don't need the org/group, and the
-# pure formatter needs only the cache. This mirrors the existing GitHub
-# collectors (e.g. privileged_access, permission_matrix).
-sonar.issue.ignore.multicriteria=e1
-sonar.issue.ignore.multicriteria.e1.ruleKey=python:S1172
-sonar.issue.ignore.multicriteria.e1.resourcePath=applications/**/collectors/**/*.py
diff --git a/tui/README.md b/tui/README.md
index d84bfac..2b765fc 100644
--- a/tui/README.md
+++ b/tui/README.md
@@ -8,6 +8,10 @@ GitHub, GitLab, and AWS are supported. Adding a platform is a matter of writing
 a runner and a `Platform` descriptor in `tui/platforms.py` — the screens are
 platform-agnostic.
 
+| Pick a platform | Choose checks | Watch it run |
+|---|---|---|
+| ![Platform menu](../docs/screenshots/menu.png) | ![Check selection](../docs/screenshots/checks.png) | ![Live run](../docs/screenshots/run.png) |
+
 ## Run it
 
 ```bash