Skip to content

SWAO - Quick Start ​

Read time: 5 minutes. Install to first assessment: about 15 minutes.

SWAO is a sovereign workload assessment platform. Given a cloud application, it produces: an audit-grade assessment report, a PowerBI dashboard, an HTML publication, and a 7R migration verdict - with full traceability on every signal and compliance verdict.


Prerequisites ​

  • Windows / macOS / Linux (no runtime required - pre-built binary)
  • A workload to assess (your own repo, or the example workspace bundled with SWAO)
  • Optional: Anthropic API key for real-LLM analysis. Without it, use --skip-llm for deterministic offline output.
  • Optional: PowerBI Desktop (Windows only) to open the resulting dashboard.

Install ​

Download the binary for your platform from the SWAO Releases page:

PlatformFile
Windows x64swao-community-win-x64.exe
macOS Apple Siliconswao-community-macos-arm64
macOS Intelswao-community-macos-x64
Linux x64swao-community-linux-x64
bash
# macOS / Linux -- make executable and put on PATH
chmod +x swao-community-linux-x64
mv swao-community-linux-x64 /usr/local/bin/swao

Verify:

bash
swao --version
# SWAO -- Sovereign Workload Assessment & Onboarding v0.11.2 (Community)

First assessment - via the guided interface ​

Run swao with no arguments to open the terminal user interface:

bash
swao

The main menu appears:

SWAO -- Sovereign Workload Assessment and Onboarding
Community  v0.11.2

  1  Workspace Setup       init + LLM + credentials wizard
  2  Health Check          swao health-check
  3  Run Assessment        Application / Landing Zone / LLM + more
  4  Generate Report       swao report (text / PDF)
  5  Publish HTML          swao publish -- self-contained HTML file
  6  Export BI             star schema / PowerBI / Tableau
  7  Portfolio Operations  multi-app aggregate (Enterprise)
  8  Generate TF Modules   swao generate-tf
  9  Tools                 lenses / licence / credentials / help
  0  Exit

Use the arrow keys or type the number to navigate.

See also: Sample Gallery - TUI Main Menu

Step 1: Workspace Setup ​

Select 1. Workspace Setup. The wizard walks through these steps:

  1. Workspace - engagement name, client code, owner, and workspace directory (e.g. my-engagement).
  2. LLM provider - Anthropic Claude, OpenAI, Amazon Bedrock Gateway, a local Ollama model, or a stub for offline testing.
  3. Credentials - the API key for the chosen provider.
  4. Health check, then the optional Claude Desktop and Playwright integrations.

New workspaces contain four demo frameworks. Copy more into the workspace at any time with swao framework install <ID> (swao framework list shows the IDs); you choose the frameworks for each app when you run the assessment.

The wizard creates the workspace folder and configuration on disk. No further setup needed.

Step 2: Health Check ​

Select 2. Health Check from the main menu. The pre-flight probes (25 in the current release) run and each reports ok or a specific action to take. Among them:

ProbeWhat it checks
LicenceEdition detected and valid
PlaywrightDynamic analysis readiness
MCPModel Context Protocol configuration
Compliance cataloguesFramework files present and consistent
Import templatesIngestion folder structure
TraceabilityAudit-grade signal fields enabled
BI export bundlePrevious export integrity

All probes green means you are ready to assess.

Step 3: Run Assessment ​

Select 3. Run Assessment from the main menu. Choose Application Assessment (the full source-code pipeline). SWAO runs automatically - a live progress bar shows each pass.

Typical duration and cost:

Workload sizeDuration (real Anthropic)Cost (real Anthropic)
Small (<100 files)~30 sec~$0.02
Medium (~1,000 files)3-5 min~$0.10
Large (~10,000 files)10-15 min~$0.50

Anthropic prompt-caching makes re-runs effectively free: a 3-month engagement running SWAO weekly costs single-digit dollars in tokens.

Step 4: View your results ​

When the assessment finishes, open the HTML publication:

wsp/publications/latest/index.html

The publication includes an executive summary, full signal trace, compliance table, and auditor view - all in a single self-contained file you can email or use offline.


See the PowerBI dashboard ​

If you have PowerBI Desktop, the .pbit template is in your workspace:

wsp/templates/powerbi/swao-report.pbit

Open it in PowerBI Desktop. When prompted for SWAOExportPath, paste the path to the star/ folder inside your latest export:

C:\my-engagement\apps\my-app\wsp\exports\2026-05-11T12-00-00\star

Click Load. Six pages render: Overview, Compliance, Signals, Risks, Auditor, Run Stats.

For portfolio assessments (multiple apps), use swao-portfolio.pbit with parameter SWAOPortfolioExportPath. See the Export BI runbook for multi-bundle workflows.

No PowerBI? Open wsp/exports/<ts>/xlsx/swao-export.xlsx in Excel for the same data in an 18-sheet workbook.


What you have produced ​

After the steps above, your workspace holds:

wsp/
+-- runs/<timestamp>/
|   +-- passes/01-inv.yaml ... 14-evidence.yaml
|   +-- run-manifest.json    LLM provider, cost, schema version
+-- exports/<timestamp>/
|   +-- star/                17 CSVs (star schema, UTF-8 BOM)
|   +-- ndjson/              17 mirror files for ETL pipelines
|   +-- xlsx/swao-export.xlsx
|   +-- manifest.yaml        SHA-256 + row counts per file
+-- publications/latest/
|   +-- index.html           self-contained HTML report
+-- reports/auditor.md       Markdown audit report

Every signal carries: outcome, derivation, false_positive_considered, assessor (rule_engine or llm), and assessed_at (ISO timestamp).


Alternatively: via the command line ​

The same steps can be run directly from the terminal:

bash
# 1. Create workspace
swao init --name my-app

# 2. Set LLM key
swao credential set anthropic-api-key <your-api-key>

# 3. Copy a compliance framework into the workspace and select it
swao framework install GDPR
swao regime-select --app my-app --regimes GDPR

# 4. Pre-flight check
swao health-check

# 5. Assess + export
swao assess --app my-app
swao export --app my-app --formats csv,ndjson,xlsx

Next steps ​

You want toRead
Re-run with a new export in PowerBIExport BI runbook
Add a community frameworkswao framework install <id> or copy a framework folder into wsp/inputs/catalogs/community/<folder>/
Run a portfolio assessmentswao export --portfolio (Consultant/Enterprise tier)
Connect Claude AI via MCPHow it works - MCP
Share findings with a clientOpen wsp/publications/latest/index.html

Help ​

bash
swao --help
swao <command> --help
swao health-check

SWAO is file-only on disk - no telemetry, no hosted endpoint, no call-home. Your source code never leaves your machine.