Pretorin Cli

🚀 Pretorin - 开发者合规工具

Pretorin 是一款为开发者打造的合规工具，可与 AI 代理或 CI 管道集成，助力开发者便捷处理合规数据、实现上下文及证据工作流。

🚀 快速开始

安装与登录

uv tool install pretorin
pretorin login

运行演示

bash scripts/demo-walkthrough.sh

✨ 主要特性

两种使用模式

1. Pretorin 托管模型模式：运行 pretorin agent run 并通过 Pretorin /v1 端点路由模型调用。
2. 自带代理模式：运行 pretorin mcp-serve 并将 MCP 服务器连接到现有的 AI 工具（如 Claude Code、Codex CLI、Cursor 等）。

📦 安装指南

托管模型工作流（推荐）

1. 使用 Pretorin API 密钥进行身份验证：

pretorin login

2. 可选：将模型流量指向自定义/自托管的 Pretorin 端点：

pretorin config set model_api_base_url https://platform.pretorin.com/v1

3. 验证运行时设置：

pretorin agent doctor
pretorin agent install

4. 运行代理任务：

pretorin agent run "Assess AC-2 implementation gaps for my system"

关键行为：

• 首选设置是使用 pretorin login 且不进行 shell 级别的 OPENAI_API_KEY 覆盖。
• 模型密钥优先级为：OPENAI_API_KEY -> config.api_key -> config.openai_api_key。
• 如果在 shell 中设置了 OPENAI_API_KEY，它将覆盖存储的登录凭据。

添加到您的 AI 工具

1. Claude Code

claude mcp add --transport stdio pretorin -- pretorin mcp-serve

通过 .mcp.json 进行团队设置：

{
  "mcpServers": {
    "pretorin": {
      "type": "stdio",
      "command": "pretorin",
      "args": ["mcp-serve"]
    }
  }
}

2. Codex CLI

添加到 ~/.codex/config.toml：

[mcp_servers.pretorin]
command = "pretorin"
args = ["mcp-serve"]

关于 Claude Desktop、Cursor 和 Windsurf 的设置，请参阅 docs/MCP.md。

💻 使用示例

基础用法

# 安装并登录
uv tool install pretorin
pretorin login

高级用法

# 运行代理任务
pretorin agent run "Assess AC-2 implementation gaps for my system"

📚 详细文档

核心命令

平台支持的审查和更新工作流是单范围的：首先使用 pretorin context set 设置一个活动的 system + framework，然后在该范围内运行证据、笔记、监控、叙述或 MCP 辅助合规命令。多框架工作必须拆分为单独的运行。证据、叙述和笔记都支持本地优先工作流：在本地创建、列出，然后推送到平台。

工件创作规则

• 叙述和证据的 Markdown 必须对审计人员具有可读性：不使用 Markdown 标题，使用列表、表格、代码块和链接。
• 在平台端支持文件上传之前，暂时禁用 Markdown 图像嵌入。

配置

凭据存储在 ~/.pretorin/config.json 中。

文档查看

完整文档使用 mdbook 构建。要在本地查看：

# 安装 mdbook（如果没有安装）
cargo install mdbook

# 启动文档服务并在浏览器中打开
cd docs && mdbook serve --open

这将在 http://localhost:3000 启动一个本地服务器，并支持实时重新加载。

要构建静态 HTML 而不启动服务：

cd docs && mdbook build
# 输出在 docs/book/ 中

快速链接

• CLI 参考
• MCP 集成指南
• 捆绑技能指南
• 贡献指南

🔧 技术细节

开发步骤

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

📄 许可证

本项目采用 MIT 许可证。详情请参阅 LICENSE。

⚠️ 重要提示

Pretorin 目前处于封闭测试阶段。框架/控制浏览对所有人开放。平台写入功能（证据、叙述、监控）需要测试代码。点击此处注册以获取早期访问权限。