Boring Documentation
Boring for Gemini - The autonomous AI development loop. Make AI development boring (in a good way). Current Version: V15.1.0 (Smart Wizard + Ecosystem Sync)
📋 更新日誌
目錄 (Table of Contents)
- 🚀 Quick Start
- 📦 Installation Options
- 📚 Documentation Structure
- Features (功能)
- Guides (指南)
- Tutorials (教學)
- Reference (參考)
- API Documentation
- 🌏 繁體中文文檔
- 功能
- 指南
- 教學
- 參考
- API 文檔
- 🔗 External Links
- 📝 Contributing
🚀 Quick Start
Choose your path:
| You Are | Start Here |
|---|---|
| 🎨 Vibe Coder (describe & build) | Vibe Coder Guide |
| 💻 Developer (hands-on) | Quick Tutorials |
| 🔧 DevOps/CI | Quality Gates |
| 🏢 Team Lead | Pro Tips |
📦 Installation Options
| Method | Profile | RAG Capability | Best For |
|---|---|---|---|
| Smithery (Remote) | lite (default) |
⚠️ Keyword only | Quick setup, daily development |
Local pip [all] |
standard/full |
✅ Vector + Semantic | Full RAG, complete features |
| Local pip (minimal) | lite |
⚠️ Keyword only | Lightweight, CI/CD |
📋 Smithery Deployment: Uses
[mcp-lite](~500MB),liteprofile by default (~20 tools). For full RAG with vector search, use local installation.
📚 Documentation Structure
✨ Core Features (功能)
Core capabilities explained in depth.
| Feature | Description |
|---|---|
| ✨ Vibe Coder Experience | NEW: Pure Natural Language Coding (中文) |
| 🧠 External Intelligence | NEW: Context7 (Docs) + Thinking Mode (中文) |
| 🖥️ Monitoring Tools | NEW: TUI, Web Dashboard & Brain Explorer (中文) |
| 🕵️ Hybrid RAG | POWER: HyDE + Cross-Encoder + Graph (中文) |
| 🧠 Memory System | BRAIN: Persistent Learning & Recall (中文) |
| 🤖 Autonomous Agents | LOOP: Planner, Coder, Reviewer Squad (中文) |
| MCP Toolset | 60+ Tools, Profiles, Router (中文) |
| Shadow Mode | Security Sandbox (中文) |
| 📉 Token Optimization | NEW: Verbosity & Caching (中文) |
| 🧬 Cognitive Evolution | V13.0: Memory, Reasoning, Skills (中文) |
| 🪢 Node.js Autonomy | NEW: Zero-config Node.js management (中文) |
| Quality Gates | CI/CD integration and verification levels |
| 🔮 Predictive Intelligence | POWER: AI Diagnostics & Prevention (中文) |
| 🔌 Offline-First Mode | PRIVACY: Zero-network operations (中文) |
| 💎 Hidden Gems | Pro: Advanced tips & secrets (中文) |
Guides (指南)
Practical how-to content.
| Guide | Description |
|---|---|
| 🎯 Usage Modes | NEW: MCP vs YOLO vs Autonomous (中文) |
| 🚀 YOLO + Boring | NEW: Maximum automation guide (中文) |
| 🔄 Workflow Comparison | NEW: Code-level analysis of Start vs Session (中文) |
| ⚙️ MCP Configuration | NEW: Profiles, ENV vars, Smithery vs Local (中文) |
| 🎛️ MCP Profiles | NEW: Code-level analysis of Lite vs Standard (中文) |
| 🛠️ Tool Manual | NEW: Complete tool usage guide (English) |
| 📊 Evaluation Metrics | NEW: Kappa, Spearman, F1, Bias Monitoring (English) |
| Vibe Coder Guide | For description-based developers |
| Quick Tutorials | 5-minute step-by-step guides |
| Cookbook | Ready-to-use recipes for all features |
| Pro Tips | Expert techniques by skill level |
| Git Hooks | Automated commit/push verification |
| Agentic Workflows | Slash Commands: /release-prep and SOPs |
| Knowledge System | Brain, RAG & Patterns - storage and migration |
| Plugin Guide | Extend Boring with custom Python tools |
| Knowledge & Brain | Pro: Backup & sharing intelligence |
| Human Alignment | Pro: Steer AI with Rubrics & Memory |
| Modular Installation | NEW: "Boring Diet" & Extras Guide (中文) |
| API Integration | Use Boring as a Python library |
| Skills Guide | Learning: Master the Boring Skill Tree |
| Pack Format | Ecosystem: Spec for .boring-pack |
| Registry Format | Ecosystem: Spec for registry.json |
| Collaboration | Ecosystem: GitOps Sync & Sharing |
| HuggingFace Integration | Ecosystem: Free Brain Backup |
Tutorials (教學)
In-depth learning resources.
| Tutorial | Description |
|---|---|
| Basic Tutorial | Getting started with Boring |
| Advanced Tutorial | Deep dive into advanced features |
| Practical Demo | Real-world project walkthrough |
| Professional Playbook | Enterprise usage patterns |
| Offline Quickstart | NEW: Zero-network setup guide |
Reference (參考)
Deep dive technical documentation.
| Reference | Description |
|---|---|
| Configuration | Cookbook: Recipes for Save Money/Max Power (中文) |
| API Reference | Complete Specs: Core, Tools, Vibe (Auto-generated) |
| Troubleshooting | Deep Dive: Diagnosis & common fixes |
| Architecture | Deep Dive: Internals & Design |
| Tool Reference (Appendix A) | Complete API documentation |
| Security & Privacy | Deep Dive: Data flows & protection |
| Agent Comparison | Deep Dive: Boring vs Cursor/Claude |
| FAQ (Appendix B) | Common questions answered |
| Prompt Philosophy (Appendix C) | AI prompt design principles |
| Architect Mode | High-level architecture planning |
API Documentation
| Page | Description |
|---|---|
| Intelligence API | NEW: Brain, Vector Memory, Patterns |
| Loop & Workflow API | NEW: Shadow Mode, Transactions |
| Judge API | NEW: Rubrics, Metrics, Evaluation |
| Security API | NEW: Security Scanner & Guard |
| Agents API | Orchestrator, Coder, Reviewer logic |
| MCP Server API | Model Context Protocol integration |
🌏 繁體中文文檔
功能
| 功能 | 說明 |
|---|---|
| 效能與架構 | 增量驗證、快取、平行化 |
| 📉 Token 優化 | 最新: Verbosity 控制與 Prompt Caching |
| Vibe Coder Pro | 最新: 文件生成、測試生成、衝擊分析、友善審查 |
| 🧬 認知進化 | V13.0: 記憶、推理、技能、合成 |
| 品質閘道 | CI/CD 整合和驗證級別 |
| 🔮 預測性智慧 | 最新: AI 診斷與主動預警 |
| 🔌 離線優先模式 | 最新: 零網路依賴與隱私保障 |
| 🪢 Node.js 自主權 | 最新: 自動下載與管理環境 |
指南
| 指南 | 說明 |
|---|---|
| Vibe Coder 指南 | 給描述式開發者 |
| 工作流程比較 | 最新: Start vs Session 的代碼級分析 |
| 快速教學 | 5 分鐘逐步指南 |
| Cookbook | 所有功能的即用食譜 |
| 專業技巧 | 按技能水平的專家技術 |
| Git Hooks | 自動化提交/推送驗證 |
| 代理工作流 | 斜槓指令：/release-prep 與 SOP 自動化 |
| 知識系統 | Brain、RAG 與 Patterns - 儲存與遷移 |
| 插件開發指南 | 使用自定義 Python 工具擴充 Boring |
| 知識與大腦管理 | 進階：備份與分享學習成果 |
| 人類對齊指南 | 進階：使用 Rubrics 與記憶引導 AI |
| API 整合指南 | 將 Boring 作為 Python 函式庫使用 |
| 模組化安裝指南 | 最新: "Boring Diet" 與延伸安裝說明 |
| 技能指南 | 掌握 Boring 技能樹 |
| Pack 格式規範 | 生態系：.boring-pack 打包標準 |
| Registry 格式規範 | 生態系：插件註冊表標準 |
| 去中心化協作指南 | 生態系：GitOps 同步與分享 |
| HuggingFace 整合指南 | 生態系：大腦免費雲端備份 |
教學
| 教學 | 說明 |
|---|---|
| 基礎教學 | 開始使用 Boring |
| 進階教學 | 深入進階功能 |
| 實戰演示 | 真實專案演練 |
| 專業手冊 | 企業使用模式 |
參考
| 參考 | 說明 |
|---|---|
| 配置手冊 | 深度指南：.boring.toml 與環境變數 |
| 故障排除 | 深度指南：診斷與常見修復 |
| 架構原理 | 深度指南：內部機制與設計 |
| 工具參考（附錄 A） | 完整 API 文檔 |
| 安全與隱私白皮書 | 深度指南：資料流向與防護機制 |
| 工具對比分析 | 深度指南：Boring vs Cursor/Claude |
| 常見問題（附錄 B） | 常見問題解答 |
| 提示詞哲學（附錄 C） | AI 提示設計原則 |
| 架構師模式 | 高階架構規劃 |
API 文檔
| 頁面 | 說明 |
|---|---|
| 智能 API (Intelligence) | 最新: 大腦、向量記憶、模式學習 |
| 工作流 API (Loop) | 最新: 影子模式、原子交易 |
| 評審 API (Judge) | 最新: 評分準則、指標、自動評估 |
| 安全 API (Security) | 最新: 安全掃描與防護守衛 |
| 代理 API (Agents) | 編排器、編碼員、審核員邏輯 |
| MCP 伺服器 API | 模型內容協定 (MCP) 整合 |
🔗 External Links
📝 Contributing
See Contributing Guide for how to contribute to Boring.