azdocs documentation
azdocs collects accessible Azure configuration and service evidence into local
SQLite snapshots. The CLI, terminal browser and desktop share the same Rust
core; reports, diagrams and stored-evidence exploration work offline.
flowchart LR
azure[Entra authentication · ARG · ARM] --> collect[CLI or desktop collection]
collect --> db[(SQLite snapshots)]
sites[Website endpoints] --> capture[Desktop website capture]
collect --> capture
capture --> db
db --> report[Markdown · HTML/site · CSV · XLSX · PDF · DOCX]
db --> diagram[draw.io · Mermaid · SVG · PNG]
db --> browse[TUI and desktop exploration]
Connection tests, collection and screenshot capture/refresh need network access.
Reports and diagrams read saved evidence only; they do not contact Azure or
websites. Scope and permissions limit what can be collected.
Guides
| Page | Covers |
|---|
| Installation | Homebrew, direct downloads, source builds and shell completions |
| Configuration | Named tenants, shared defaults, native secrets, migration and environment references |
| Permission diagnostics | Connection tests, RBAC verdicts and coverage limits |
| Collecting | Running the query pack, scoping, throttling |
| Reports | Assessments, technical references, Markdown, HTML/site, CSV and XLSX |
| Diagrams | draw.io, Mermaid, SVG/PNG, scopes and workbooks |
| The TUI | Browsing snapshots interactively |
| Desktop explorer | Tauri app, estate navigation, findings, topology |
| Website screenshots | Capture, refresh, saved evidence and offline exports |
| Snapshots | Listing, diffing, pruning |
| Queries | Ad-hoc KQL and custom query packs |
| CI | Running azdocs in pipelines |
| Troubleshooting | Common errors and limitations |
| Page | Covers |
|---|
| Query pack | Built-in queries, findings and Rust-side audits |
| Operational evidence | Sources, retention, scope, coverage and interpretation |
| Labels | User wording, placeholders and partial overrides |
| Themes | Document theme files: palette expressions, type scale, layout strategies |
| Diagram standards | Detail levels, A4 page fractions, density rungs, connector routing |
| Desktop design language | Desktop tokens, typography, Overview dashboard and evidence workspace rules |
| Design sheet | Generated swatches, type scale and brand marks |
Versioned notes for the CLI and desktop packages published through GitHub
Releases and Homebrew.
Project policies
