Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Complete Command Reference

Global Options

OptionDescription
--jsonJSON output mode for scripting and AI agents
--helpShow command help

Root Commands

CommandDescription
pretorin loginAuthenticate with the Pretorin API
pretorin logoutClear stored credentials
pretorin whoamiDisplay authentication status
pretorin versionShow CLI version
pretorin updateUpdate to latest version
pretorin mcp-serveStart the MCP server (stdio transport)

Framework Commands

CommandDescription
pretorin frameworks listList all frameworks
pretorin frameworks get <id>Get framework details
pretorin frameworks families <id>List control families
pretorin frameworks family <fw> <family>Get control family details
pretorin frameworks controls <id>List controls (--family, --limit)
pretorin frameworks control <fw> <ctrl>Get control details (--references)
pretorin frameworks documents <id>Get document requirements
pretorin frameworks metadata <id>Get per-control framework metadata
pretorin frameworks submit-artifact <file>Submit a compliance artifact JSON file

Context Commands

CommandDescription
pretorin context listList systems and frameworks with progress
pretorin context setSet active system/framework context (--system, --framework)
pretorin context showDisplay current active context
pretorin context clearClear active context

Evidence Commands

CommandDescription
pretorin evidence create <ctrl> <fw>Create a local evidence file (--name, --description)
pretorin evidence listList local evidence files (--framework)
pretorin evidence pushPush local evidence to the platform
pretorin evidence searchSearch platform evidence (--control-id, --framework-id, --system, --limit)
pretorin evidence upsert <ctrl> <fw>Find-or-create evidence and link it (--name, --description, --type)

Narrative Commands

CommandDescription
pretorin narrative get <ctrl> <fw>Get current control narrative (--system)
pretorin narrative push <ctrl> <fw> <sys> <file>Push a narrative file to the platform

Notes Commands

CommandDescription
pretorin notes list <ctrl> <fw>List control notes (--system)
pretorin notes add <ctrl> <fw>Add a control note (--content)

Monitoring Commands

CommandDescription
pretorin monitoring pushPush a monitoring event (--system, --title, --event-type, --severity)

Agent Commands

CommandDescription
pretorin agent run "<task>"Run a compliance task (--skill, --model, --base-url, --working-dir, --no-stream, --legacy)
pretorin agent doctorValidate Codex runtime setup
pretorin agent installDownload the pinned Codex binary
pretorin agent versionShow pinned Codex version and install status
pretorin agent skillsList available agent skills
pretorin agent mcp-listList configured MCP servers for the agent
pretorin agent mcp-add <name> stdio <cmd>Add an MCP server configuration (--arg)
pretorin agent mcp-remove <name>Remove an MCP server configuration

Review Commands

CommandDescription
pretorin review runReview code against a control (--control-id, --framework-id, --path, --local, --output-dir)
pretorin review statusCheck implementation status for a control (--control-id)

Config Commands

CommandDescription
pretorin config listList all configuration
pretorin config get <key>Get a config value
pretorin config set <key> <value>Set a config value
pretorin config pathShow config file path

Deprecated Commands

CommandDescription
pretorin harness initDeprecated: initialize harness config
pretorin harness doctorDeprecated: validate harness setup
pretorin harness run "<task>"Deprecated: run task through harness backend