Quick Start

The fastest way to try Auditaur is the dogfood app in examples\dogfood.

To add Auditaur to an existing app instead, start with Integration Happy Path. If you need the detailed app integration checklist, use Add Auditaur to a Tauri App. If you are replacing tauri-plugin-log, use Migrate from tauri-plugin-log.

cd examples\dogfood
npm install
npm run build:api
auditaur observe --app dogfood -- npm run tauri dev

Click the buttons to emit a console log, throw a frontend error, call successful and failing Tauri commands, and emit/listen to events.

observe starts the normal Tauri dev command, waits for core Auditaur readiness, writes .auditaur\session.json, and leaves the app running. Use --session-file .auditaur\session.json for follow-up read commands instead of --latest or copied selectors when multiple stale sessions exist. Core readiness does not require frontend telemetry; add --require-frontend only when your check must wait for WebView telemetry, which may need a click or other interaction.

Inspect the session:

auditaur logs --session-file .auditaur\session.json --json
auditaur ipc --session-file .auditaur\session.json --json
auditaur explain --session-file .auditaur\session.json
auditaur errors --db "<databasePath>" --session "<sessionId>" --json
auditaur traces --db "<databasePath>" --session "<sessionId>" --json
auditaur ipc --db "<databasePath>" --session "<sessionId>" --json
auditaur events --db "<databasePath>" --session "<sessionId>" --json

Stop the observed app when you are done:

auditaur stop --session-file .auditaur\session.json

Use cargo run -p auditaur-cli -- mcp to expose the same database-backed tools to an MCP client.

For repeatable smoke checks that start the app, wait for readiness, verify a selector, write a report, and clean up the app automatically, use Drill Confidence Runs.

If a command does not show what you expect, use Troubleshooting or jump to CLI Recipes for common command sequences.