CLI and MCP server for Pretorin Compliance API
Project description
Compliance tools for developers. Integrate with AI agents or your CI pipeline.
Beta — Pretorin is currently in closed beta. Framework/control browsing works for everyone. Platform write features (evidence, narratives, monitoring) require a beta code. Sign up for early access.
Pretorin CLI gives developers and AI agents direct access to compliance data, implementation context, and evidence workflows.
mcp-name: io.github.pretorin-ai/pretorin
Two Usage Modes
- Pretorin-hosted model mode: run
pretorin agent runand route model calls through Pretorin/v1endpoints. - Bring-your-own-agent mode: run
pretorin mcp-serveand connect the MCP server to your existing AI tool (Claude Code, Codex CLI, Cursor, etc.).
Quick Start
uv tool install pretorin
pretorin login
pretorin skill install
Run the walkthrough:
bash scripts/demo-walkthrough.sh
Hosted Model Workflow (Recommended)
Use this flow when you want pretorin agent run to go through Pretorin-hosted model endpoints.
- Authenticate with your Pretorin API key:
pretorin login
- Optional: point model traffic to a custom/self-hosted Pretorin endpoint:
pretorin config set model_api_base_url https://platform.pretorin.com/api/v1/public/model
- Verify runtime setup:
pretorin agent doctor
pretorin agent install
- Run an agent task:
pretorin agent run "Assess AC-2 implementation gaps for my system"
Key behavior:
- Preferred setup is
pretorin loginwith no shell-levelOPENAI_API_KEYoverride. - Model key precedence is:
OPENAI_API_KEY->config.api_key->config.openai_api_key. - If
OPENAI_API_KEYis set in your shell, it overrides stored login credentials.
Add to Your AI Tool
Use this flow when you already have an AI agent/tool and want Pretorin as an MCP capability provider.
Install the Skill
The Pretorin skill teaches your AI agent how to use MCP tools effectively for compliance workflows. Install it for Claude Code and/or Codex CLI:
pretorin skill install # both agents
pretorin skill install --agent claude # claude only
pretorin skill install --agent codex # codex only
pretorin skill status # check what's installed
1. Claude Code
claude mcp add --transport stdio pretorin -- pretorin mcp-serve
Team setup via .mcp.json:
{
"mcpServers": {
"pretorin": {
"type": "stdio",
"command": "pretorin",
"args": ["mcp-serve"]
}
}
}
2. Codex CLI
Add to ~/.codex/config.toml:
[mcp_servers.pretorin]
command = "pretorin"
args = ["mcp-serve"]
If you installed Pretorin with uv tool install or pipx, prefer pinning the absolute path from command -v pretorin to avoid PATH drift between shells and GUI apps.
For Claude Desktop, Cursor, and Windsurf setup, see docs/MCP.md.
Core Commands
Platform-backed review and update workflows are single-scope: set one active system + framework first with pretorin context set, then run evidence, note, monitoring, narrative, or MCP-assisted compliance commands inside that scope. Multi-framework work must be split into separate runs. Evidence, narratives, and notes all support a local-first workflow: create locally, list, then push to the platform.
| Command | Purpose |
|---|---|
pretorin frameworks list |
List available frameworks |
pretorin frameworks control <framework> <control> |
Get control details and guidance |
pretorin context set |
Set active system/framework context |
pretorin context show |
Inspect and validate the active context |
pretorin context clear |
Clear the active context |
pretorin evidence create |
Create local evidence file |
pretorin evidence list |
List local evidence files |
pretorin evidence push |
Push local evidence to Pretorin |
pretorin evidence search |
Search platform evidence |
pretorin evidence upsert <ctrl> <fw> |
Find-or-create evidence and link it |
pretorin narrative create |
Create local narrative file |
pretorin narrative list |
List local narrative files |
pretorin narrative push |
Push local narratives to Pretorin |
pretorin narrative get <ctrl> <fw> |
Get current control narrative |
pretorin narrative push-file <ctrl> <fw> <sys> <file> |
Push a single narrative file |
pretorin notes create |
Create local note file |
pretorin notes list --local |
List local note files |
pretorin notes push |
Push local notes to Pretorin |
pretorin notes list <ctrl> <fw> |
List platform control notes |
pretorin notes add <ctrl> <fw> --content ... |
Add control note directly |
pretorin monitoring push |
Push a monitoring event |
pretorin agent run "<task>" |
Run Codex-powered compliance task |
pretorin review run --control-id <id> --path <dir> |
Review local code for control coverage |
pretorin skill install |
Install Pretorin skill for AI agents |
pretorin skill status |
Check skill install status per agent |
pretorin mcp-serve |
Start MCP server |
Quick context checks:
pretorin context show --quiet
pretorin context show --quiet --check
pretorin login clears the stored active context when you switch API keys or platform endpoints, which helps prevent old localhost or deleted-system scope from leaking into a new environment.
Artifact Authoring Rules
- Narrative and evidence markdown must be human-readable for auditors: no markdown headings, use lists/tables/code blocks/links.
- Markdown image embeds are temporarily disabled until platform-side file upload support is available.
Configuration
Credentials are stored at ~/.pretorin/config.json.
| Variable | Description |
|---|---|
PRETORIN_API_KEY |
API key for platform access (overrides stored config) |
PRETORIN_PLATFORM_API_BASE_URL |
Platform REST API base URL (/api/v1/public) |
PRETORIN_API_BASE_URL |
Backward-compatible alias for PRETORIN_PLATFORM_API_BASE_URL |
PRETORIN_MODEL_API_BASE_URL |
Model API base URL used by agent/harness flows (default: https://platform.pretorin.com/api/v1/public/model) |
OPENAI_API_KEY |
Optional model key override for agent runtime |
Documentation
Full documentation is built with mdbook. To view it locally:
# Install mdbook (if you don't have it)
cargo install mdbook
# Serve the docs and open in your browser
cd docs && mdbook serve --open
This starts a local server at http://localhost:3000 with live-reload.
To build static HTML without serving:
cd docs && mdbook build
# Output is in docs/book/
Quick links
Development
git clone https://github.com/pretorin-ai/pretorin-cli.git
cd pretorin-cli
uv pip install -e ".[dev]"
pytest
ruff check src/pretorin
ruff format --check src/pretorin
License
MIT License. See LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pretorin-0.13.0.tar.gz.
File metadata
- Download URL: pretorin-0.13.0.tar.gz
- Upload date:
- Size: 1.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bacf19e0999baa79a21773d207bf3f995566da582ff20342d7b81bbc33f29196
|
|
| MD5 |
5be0677c9881811e0dec4ce288db7952
|
|
| BLAKE2b-256 |
cdb02730efd87dfde19c74ea6f3147049e4376d8772bf75b682b58852c1692b0
|
File details
Details for the file pretorin-0.13.0-py3-none-any.whl.
File metadata
- Download URL: pretorin-0.13.0-py3-none-any.whl
- Upload date:
- Size: 221.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a2dd794a384edf7dad3eba6b8200743dfd7257b793b8d4331542549b11cc9b5e
|
|
| MD5 |
ca9456aafd1fbca945bbed061ce34680
|
|
| BLAKE2b-256 |
ea911d78cab8ee8e48430b11972509971077f1ff0d1ec6be42268b30232b3c9e
|