Installation

Auditaur ships as Rust crates plus the @auditaur/api npm package. The CLI binary is provided by the auditaur-cli crate and is installed as auditaur.

Prerequisites

1. Rust and Cargo.
2. Node.js 24 or newer for the docs and example app.
3. Tauri v2 prerequisites for your operating system.

Install the CLI

cargo install auditaur-cli
auditaur doctor

Add the Tauri plugin

In your Tauri app’s Rust crate:

[dependencies]
tauri-plugin-auditaur = "0.1.3"
tracing = "0.1"
tracing-subscriber = "0.3"

For the complete app setup, including capabilities, Rust registration, frontend initialization, and verification commands, see Add Auditaur to a Tauri App.

Add the frontend package

npm install @auditaur/api@0.2.1

Source checkout development

When working inside the Auditaur repository, you can still run the CLI from source:

cargo run -p auditaur-cli -- doctor
cargo run -p auditaur-cli -- apps --json

To build the frontend package locally:

cd packages\api
npm install
npm run build

Local data paths

Auditaur discovery files are written under the local data directory:

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

Each discovery file points at a SQLite session database under the matching sessions directory. Override the root during tests with AUDITAUR_DATA_DIR.

MCP client config

For a locally installed CLI:

{
  "mcpServers": {
    "auditaur": {
      "command": "auditaur",
      "args": ["mcp"]
    }
  }
}

Without installing the CLI from crates.io, point the MCP client at Cargo:

{
  "mcpServers": {
    "auditaur": {
      "command": "cargo",
      "args": ["run", "-p", "auditaur-cli", "--", "mcp"],
      "cwd": "D:\\projects\\auditaur"
    }
  }
}

Use the equivalent repository path for macOS/Linux. The MCP server uses discovery when exactly one active readable session exists; pass a db argument to tools when multiple sessions are active.

Build the docs

cd docs
npm install
npm run build

The docs site is published at https://auditaur.dev.