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 目前處於封閉測試階段。框架/控制瀏覽對所有人開放。平臺寫入功能（證據、敘述、監控）需要測試代碼。點擊此處註冊以獲取早期訪問權限。