Skip to content

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 Add Auditaur to a Tauri App. If you are replacing tauri-plugin-log, use Migrate from tauri-plugin-log.

Terminal window
cd examples\dogfood
npm install
npm run build:api
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.

While the app is running, copy databasePath from the latest discovery file:

PlatformDiscovery directory
Windows%LOCALAPPDATA%\auditaur\apps
macOS~/Library/Application Support/auditaur/apps
Linux~/.local/share/auditaur/apps

Then inspect the session:

Terminal window
cargo run -p auditaur-cli -- apps --json
cargo run -p auditaur-cli -- logs --json
cargo run -p auditaur-cli -- errors --json
cargo run -p auditaur-cli -- traces --json
cargo run -p auditaur-cli -- ipc --json
cargo run -p auditaur-cli -- events --json

You can also pass a database path explicitly:

Terminal window
cargo run -p auditaur-cli -- sessions --db "<databasePath>" --json
cargo run -p auditaur-cli -- logs --db "<databasePath>" --json
cargo run -p auditaur-cli -- errors --db "<databasePath>" --json
cargo run -p auditaur-cli -- traces --db "<databasePath>" --json

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