Pretorin Developer & Agent Docs
Canonical docs base: https://pretorin-ai.github.io/pretorin-cli/
Audience: developers and AI agents using Pretorin via the CLI, MCP, and skill-driven workflows.

Overview
- Introduction
  URL: https://pretorin-ai.github.io/pretorin-cli/introduction.html
  Summary: high-level orientation to Pretorin for developers and AI agents, including CLI-first, AI-agent-first, and hosted runtime usage modes.

Getting Started
- Installation
  URL: https://pretorin-ai.github.io/pretorin-cli/getting-started/installation.html
  Summary: install the Pretorin CLI with uv, pip, pipx, or Docker.
- Authentication
  URL: https://pretorin-ai.github.io/pretorin-cli/getting-started/authentication.html
  Summary: obtain an API key, authenticate the CLI, and understand account-scoped hosted access.
- Quick Start
  URL: https://pretorin-ai.github.io/pretorin-cli/getting-started/quickstart.html
  Summary: first commands for framework browsing, context setup, evidence, agents, and MCP connection.

CLI Reference
- Framework Browsing
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/frameworks.html
  Summary: list frameworks, inspect framework details, list families, and inspect controls.
- Context Management
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/context.html
  Summary: manage the active system and framework scope used by platform-backed workflows.
- Evidence
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/evidence.html
  Summary: create, list, search, link, and push evidence artifacts.
- Narratives
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/narratives.html
  Summary: create, inspect, and push control narratives.
- Notes
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/notes.html
  Summary: local and platform control notes.
- Monitoring
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/monitoring.html
  Summary: push monitoring and compliance events.
- Campaign Workflows
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/campaigns.html
  Summary: bulk workflows for controls, policy questions, and scope questions.
- Vendor Management
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/vendors.html
  Summary: vendor records, documents, and inheritance-oriented workflows.
- STIG and CCI Browsing
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/stig-cci.html
  Summary: browse STIGs, rules, and CCI mappings.
- STIG Scanning
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/scanning.html
  Summary: manifests, scans, and results.
- Review
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/review.html
  Summary: review local code and artifacts against compliance controls.
- Configuration
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/configuration.html
  Summary: config keys, environment variables, and runtime settings.
- Complete Command Reference
  URL: https://pretorin-ai.github.io/pretorin-cli/cli/command-reference.html
  Summary: broad command-level reference for the entire CLI.

MCP Integration
- MCP Overview
  URL: https://pretorin-ai.github.io/pretorin-cli/mcp/overview.html
  Summary: how Pretorin exposes compliance capabilities to AI assistants over MCP.
- Setup Guides
  URL: https://pretorin-ai.github.io/pretorin-cli/mcp/setup.html
  Summary: connect Pretorin MCP to Claude Code, Codex CLI, and other MCP-compatible tools.
- Tool Reference
  URL: https://pretorin-ai.github.io/pretorin-cli/mcp/tools.html
  Summary: detailed MCP tool reference.
- Resources
  URL: https://pretorin-ai.github.io/pretorin-cli/mcp/resources.html
  Summary: MCP resources surfaced by Pretorin.
- Troubleshooting
  URL: https://pretorin-ai.github.io/pretorin-cli/mcp/troubleshooting.html
  Summary: common MCP setup and runtime issues.

Agent
- Agent Overview
  URL: https://pretorin-ai.github.io/pretorin-cli/agent/overview.html
  Summary: Pretorin-hosted runtime usage with `pretorin agent run`.
- Skills
  URL: https://pretorin-ai.github.io/pretorin-cli/agent/skills.html
  Summary: skill-driven prompts and agent workflow helpers.
- Runtime Management
  URL: https://pretorin-ai.github.io/pretorin-cli/agent/runtime.html
  Summary: runtime setup and operational details.

Authoring Recipes
- Recipes Overview
  URL: https://pretorin-ai.github.io/pretorin-cli/recipes/index.html
  Summary: introduction to recipes as markdown-plus-Python playbooks the calling agent invokes through MCP.
- Manifest Reference
  URL: https://pretorin-ai.github.io/pretorin-cli/recipes/manifest-reference.html
  Summary: YAML frontmatter schema for recipe.md, frozen per pretorin minor version.
- Script Contract
  URL: https://pretorin-ai.github.io/pretorin-cli/recipes/script-contract.html
  Summary: required signature and runtime contract for recipe scripts.
- Writer Tools
  URL: https://pretorin-ai.github.io/pretorin-cli/recipes/writer-tools.html
  Summary: how recipe scripts call the platform API through ctx.api_client and how audit metadata is stamped.
- Testing Recipes
  URL: https://pretorin-ai.github.io/pretorin-cli/recipes/testing.html
  Summary: patterns for testing recipe scripts as ordinary Python modules.
- Publishing Recipes
  URL: https://pretorin-ai.github.io/pretorin-cli/recipes/publishing.html
  Summary: the three publishing tiers (official, project, user) and how the loader resolves them.
- Workflows
  URL: https://pretorin-ai.github.io/pretorin-cli/recipes/workflows.html
  Summary: workflow playbooks the calling agent reads to iterate over items in a compliance domain.
- Engagement Layer
  URL: https://pretorin-ai.github.io/pretorin-cli/recipes/engagement.html
  Summary: the routing boundary that maps user prompts to the right workflow and recipe combination.
- Worked Example
  URL: https://pretorin-ai.github.io/pretorin-cli/recipes/example/index.html
  Summary: end-to-end community recipe walkthrough capturing audit-log entries as access-control evidence.

Frameworks
- Supported Frameworks
  URL: https://pretorin-ai.github.io/pretorin-cli/frameworks/supported.html
  Summary: overview of Pretorin's 30+ framework catalog with representative examples.
- Control ID Formats
  URL: https://pretorin-ai.github.io/pretorin-cli/frameworks/control-ids.html
  Summary: canonical control ID formatting across frameworks.
- Framework Selection Guide
  URL: https://pretorin-ai.github.io/pretorin-cli/frameworks/selection.html
  Summary: choosing the right framework for an organization or system.
- Custom Frameworks
  URL: https://pretorin-ai.github.io/pretorin-cli/frameworks/custom.html
  Summary: authoring, validating, forking, and uploading custom compliance frameworks through the platform revision lifecycle.

Workflows
- Narrative and Evidence Workflow
  URL: https://pretorin-ai.github.io/pretorin-cli/workflows/narrative-evidence.html
  Summary: end-to-end narrative and evidence authoring flow.
- Campaign Workflows
  URL: https://pretorin-ai.github.io/pretorin-cli/workflows/campaigns.html
  Summary: bulk workflows across controls, policy, and scope.
- Policy and Scope Questionnaires
  URL: https://pretorin-ai.github.io/pretorin-cli/workflows/policy-scope.html
  Summary: answer, review, and generate policy/scope artifacts.
- Vendor Inheritance
  URL: https://pretorin-ai.github.io/pretorin-cli/workflows/vendor-inheritance.html
  Summary: vendor responsibility and inherited-control workflows.
- Gap Analysis
  URL: https://pretorin-ai.github.io/pretorin-cli/workflows/gap-analysis.html
  Summary: analyze compliance gaps against a codebase or system.
- Gap Analysis Example
  URL: https://pretorin-ai.github.io/pretorin-cli/workflows/gap-analysis-example.html
  Summary: example output from a gap analysis workflow.
- Artifact Generation
  URL: https://pretorin-ai.github.io/pretorin-cli/workflows/artifacts.html
  Summary: artifact formats and generation workflow.
- Cross-Framework Mapping
  URL: https://pretorin-ai.github.io/pretorin-cli/workflows/cross-framework.html
  Summary: compare and map controls across frameworks.
- STIG Compliance Scanning
  URL: https://pretorin-ai.github.io/pretorin-cli/workflows/stig-scanning.html
  Summary: scanning workflows and interpretation of results.

Reference
- Environment Variables
  URL: https://pretorin-ai.github.io/pretorin-cli/reference/environment.html
  Summary: environment-based configuration.
- Artifact Schema
  URL: https://pretorin-ai.github.io/pretorin-cli/reference/artifact-schema.html
  Summary: structured artifact schema reference.
- Contributing
  URL: https://pretorin-ai.github.io/pretorin-cli/reference/contributing.html
  Summary: contribution workflow and boundaries.
- Trademarks and Service Terms
  URL: https://pretorin-ai.github.io/pretorin-cli/reference/trademarks.html
  Summary: branding boundaries and service-term separation from open-source code.
- Changelog
  URL: https://pretorin-ai.github.io/pretorin-cli/reference/changelog.html
  Summary: release history and major changes.

Notes
- The docs prioritize CLI, MCP, skills, and workflow usage over raw API reference.
- Pretorin-hosted platform access is authenticated and governed separately by platform terms.
- For live framework availability, prefer the CLI and authenticated platform responses over static examples.
