Codemcp

🚀 CKB — 代碼知識後端

瞭解你的代碼，安全地進行更改，自信地發佈。

CKB 將你的代碼庫轉換為可查詢的知識庫。通過命令行界面（CLI）、應用程序編程接口（API）或人工智能助手，你可以提出問題、瞭解變更影響、查找代碼所有者以及檢測死代碼。

你可以將其視為一位資深工程師，他知曉代碼的每一行、每一個決策和每一位代碼所有者，並且隨時為你答疑解惑。

🚀 快速開始

選項 1：使用 npm（推薦）

# 全局安裝
npm install -g @tastehub/ckb

# 或者直接使用 npx 運行（無需安裝）
npx @tastehub/ckb init

選項 2：使用 Homebrew（適用於 macOS/Linux）

brew tap SimplyLiz/ckb
brew install ckb

選項 3：從源代碼構建

git clone https://github.com/SimplyLiz/CodeMCP.git
cd CodeMCP
go build -o ckb ./cmd/ckb

配置步驟

# 1. 在你的項目中初始化
cd /path/to/your/project
ckb init   # 或者：npx @tastehub/ckb init

# 2. 生成 SCIP 索引（可選，但推薦）
ckb index  # 自動檢測語言並運行相應的索引器

# 3. 連接到 Claude Code
ckb setup  # 自動創建 .mcp.json

# 或者手動配置：
claude mcp add --transport stdio ckb -- npx @tastehub/ckb mcp

啟動時顯示的令牌效率：

CKB MCP Server v8.0.0
  活躍工具：14 / 76 (18%)
  估計上下文：~1k 令牌
  預設：核心

現在，Claude 可以回答如下問題：

• “哪些地方調用了 HandleRequest 函數？”
• “從 API 如何調用到 ProcessPayment？”
• “如果我更改 UserService，影響範圍有多大？”
• “internal/api 模塊的所有者是誰？”
• “這段遺留代碼是否仍在使用？”

✨ 主要特性

即時解答難題

功能概述

• 🔍 理解：語義搜索、調用圖、使用追蹤、架構圖
• ⚡ 分析：影響分析、風險評分、熱點檢測、耦合分析
• 🛡️ 保護：受影響測試檢測、重大變更警告、PR 風險評估
• 🔐 安全：機密檢測、憑證掃描、安全敏感代碼識別
• 👥 協作：所有權查找、審核人建議、架構決策（ADRs）
• 📊 改進：死代碼檢測、技術債務跟蹤、文檔覆蓋率
• 🚀 複合操作：單調用工具（explore、understand、prepareChange）可將人工智能工具調用減少 60 - 70%
• 🔗 集成：命令行界面（CLI）、HTTP API、適用於人工智能工具的 MCP、CI/CD 管道、自定義腳本

📦 安裝指南

推薦使用 npm 安裝

# 全局安裝
npm install -g @tastehub/ckb

# 或者直接使用 npx 運行（無需安裝）
npx @tastehub/ckb init

使用 Homebrew 安裝（macOS/Linux）

brew tap SimplyLiz/ckb
brew install ckb

從源代碼構建

git clone https://github.com/SimplyLiz/CodeMCP.git
cd CodeMCP
go build -o ckb ./cmd/ckb

💻 使用示例

基礎用法

# 查看代碼庫中的風險區域
ckb hotspots --format=human

# 檢查變更內容以及可能出現的問題
ckb diff-summary --format=human

# 掃描暴露的機密信息
ckb audit --format=human

# 快速查看架構
ckb arch --format=human

# 檢查系統狀態
ckb status

高級用法

# 一鍵連接到 Claude Code
ckb setup

📚 詳細文檔

進一步瞭解

三種使用方式

索引工作原理

CKB 使用 SCIP 索引 來理解你的代碼，你可以將其看作一個數據庫，它知道每個函數的定義位置、調用者以及所有代碼之間的連接關係。

基本操作

# 1. 生成索引（自動檢測語言）
ckb index

# 2. 檢查索引是否最新
ckb status

如果沒有索引，CKB 仍然可以使用 tree-sitter 解析（基本模式），但有了索引，你可以獲得：

• 跨文件引用（“哪些地方調用了這個函數？”）
• 精確的影響分析
• 調用圖導航

語言支持

並非所有語言都具有相同的支持程度。CKB 根據索引器的成熟度將語言分為 質量等級：

關鍵限制：

• 增量索引 僅適用於 Go 語言。其他語言需要完全重新索引。
• TypeScript 單倉庫 可能需要 --infer-tsconfig 標誌
• C/C++ 需要 compile_commands.json
• Python 在激活虛擬環境時效果最佳

運行 ckb doctor --tier standard 檢查你的語言工具是否正確安裝。

更多信息請查看 語言支持，其中包含索引器安裝、已知問題和完整的功能矩陣。

保持索引最新

當你提交代碼時，索引會過時。CKB 提供了幾種保持索引最新的方法：

人工智能會話快速啟動：

ckb mcp --watch  # 索引過時後每 30 秒自動重新索引

檢查索引是否過時：

ckb status
# 顯示：“落後 HEAD 5 次提交” 或 “最新狀態”

對於 Go 項目，CKB 使用 增量索引，只處理更改的文件，使更新速度更快。

完整文檔請查看 索引管理指南。

功能特性

📖 完整功能指南 — 詳細文檔及示例

📋 更新日誌 — 版本歷史

CLI 命令

ckb status           # 系統健康狀態（附帶修復建議）
ckb search Handler   # 查找符號
ckb diff-summary     # 分析變更內容
ckb hotspots         # 風險區域
ckb arch             # 架構概述
ckb ownership        # 文件/路徑所有權
ckb mcp              # 啟動 MCP 服務器

v8.0 複合操作（通過 MCP）：

# 這些工具將多個查詢合併為單調用
explore      # 區域探索：符號、依賴項、熱點
understand   # 符號深入研究：引用、調用者、解釋
prepareChange # 變更前分析：影響、測試、風險
batchGet     # 一次獲取最多 50 個符號
batchSearch  # 一次運行最多 10 個搜索

📖 用戶指南 — 所有 CLI 命令和選項

HTTP API

# 啟動 HTTP 服務器
ckb serve --port 8080

# 示例調用
curl http://localhost:8080/health
curl http://localhost:8080/status
curl "http://localhost:8080/search?q=NewServer"
curl http://localhost:8080/architecture
curl "http://localhost:8080/ownership?path=internal/api"
curl http://localhost:8080/hotspots

# 索引服務器模式（v7.3） - 向遠程客戶端提供索引服務
ckb serve --port 8080 --index-server --index-config config.toml

# 索引服務器端點
curl http://localhost:8080/index/repos
curl http://localhost:8080/index/repos/company%2Fcore-lib/meta
curl "http://localhost:8080/index/repos/company%2Fcore-lib/symbols?limit=100"
curl "http://localhost:8080/index/repos/company%2Fcore-lib/search/symbols?q=Handler"

# 上傳端點（帶有壓縮和認證）
curl -X POST http://localhost:8080/index/repos \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ckb_xxx" \
  -d '{"id":"my-org/my-repo","name":"My Repo"}'

gzip -c index.scip | curl -X POST http://localhost:8080/index/repos/my-org%2Fmy-repo/upload \
  -H "Content-Encoding: gzip" \
  -H "Authorization: Bearer ckb_xxx" \
  --data-binary @-

# 令牌管理（索引服務器管理員）
ckb token create --name "ci-upload" --scope upload    # 創建 API 密鑰
ckb token list                                         # 列出所有令牌
ckb token revoke ckb_xxx                              # 撤銷令牌
ckb token rotate ckb_xxx                              # 旋轉令牌（新密鑰，相同 ID）

MCP 集成

CKB 可與任何支持 MCP 的人工智能編碼工具配合使用。

# 為當前項目自動配置
npx @tastehub/ckb setup

# 或者為所有項目全局添加
npx @tastehub/ckb setup --global

{
  "mcpServers": {
    "ckb": {
      "command": "npx",
      "args": ["@tastehub/ckb", "mcp"]
    }
  }
}

{
  "mcpServers": {
    "ckb": {
      "command": "npx",
      "args": ["@tastehub/ckb", "mcp"]
    }
  }
}

{
  "mcpServers": {
    "ckb": {
      "command": "npx",
      "args": ["@tastehub/ckb", "mcp"]
    }
  }
}

{
  "mcp": {
    "servers": {
      "ckb": {
        "type": "stdio",
        "command": "npx",
        "args": ["@tastehub/ckb", "mcp"]
      }
    }
  }
}

{
  "mcp": {
    "ckb": {
      "type": "local",
      "command": ["npx", "@tastehub/ckb", "mcp"],
      "enabled": true
    }
  }
}

# 為當前項目自動配置
npx @tastehub/ckb setup --tool=grok

# 或者全局添加
npx @tastehub/ckb setup --tool=grok --global

{
  "mcpServers": {
    "ckb": {
      "name": "ckb",
      "transport": "stdio",
      "command": "npx",
      "args": ["@tastehub/ckb", "mcp"]
    }
  }
}

cd /path/to/your/repo
ckb setup --tool=claude-desktop

{
  "mcpServers": {
    "ckb": {
      "command": "npx",
      "args": ["-y", "@tastehub/ckb", "mcp"],
      "env": {
        "CKB_REPO": "/path/to/your/repo"
      }
    }
  }
}

{
  "mcpServers": {
    "ckb": {
      "command": "cmd",
      "args": ["/c", "npx", "@tastehub/ckb", "mcp"]
    }
  }
}

# 列出所有可用預設，包括工具數量和令牌估計
ckb mcp --list-presets

# 默認：核心預設（14 個基本工具）
ckb mcp

# 特定工作流預設
ckb mcp --preset=core        # 14 個工具 - 搜索、解釋、影響分析（默認）
ckb mcp --preset=review      # 19 個工具 - 核心 + 差異、所有權
ckb mcp --preset=refactor    # 19 個工具 - 核心 + 耦合、死代碼
ckb mcp --preset=federation  # 28 個工具 - 核心 + 跨倉庫
ckb mcp --preset=docs        # 20 個工具 - 核心 + 文檔 - 符號鏈接
ckb mcp --preset=ops         # 25 個工具 - 核心 + 作業、網絡鉤子、指標
ckb mcp --preset=full        # 80 多個工具 - 所有工具（舊版）

{
  "mcpServers": {
    "ckb": {
      "command": "npx",
      "args": ["@tastehub/ckb", "mcp", "--preset=review"]
    }
  }
}

🔧 技術細節

底層原理

CKB 協調多個代碼智能後端：

• SCIP：精確的預索引符號數據（最快）
• LSP：即時語言服務器查詢
• Git：blame、歷史記錄、變更分析、所有權

結果會智能合併並壓縮，以適應大語言模型（LLM）的上下文限制。

持久知識在會話之間保持有效：

• 模塊註冊表：邊界、職責、標籤
• 所有權註冊表：CODEOWNERS + git blame，並考慮時間衰減
• 熱點跟蹤器：帶有趨勢分析的歷史快照
• 決策日誌：支持全文搜索的架構決策記錄（ADRs）

適用人群

• 使用人工智能助手的開發者：為你的人工智能工具賦予強大能力
• 擁有大型代碼庫的團隊：高效應對代碼複雜性
• 進行代碼重構的人員：在更改代碼前瞭解影響
• 代碼審核人員：全面瞭解代碼變更
• 技術負責人：長期跟蹤架構健康狀況

侷限性（客觀說明）

CKB 的優勢在於：

• 靜態代碼導航：查找定義、引用、調用圖
• 安全重構的影響分析
• 所有權查找（CODEOWNERS + git blame）
• 架構和模塊理解

CKB 無法提供幫助的方面：

• 動態調度/運行時行為（使用調試器）
• 未索引的生成代碼
• 代碼生成、代碼檢查或格式化
• 跨倉庫調用（使用 聯合 功能）

CKB 是靜態分析工具，並非萬能。在做出關鍵決策時，請始終閱讀實際代碼進行驗證。

📖 實際限制 — 關於準確性、盲點以及何時信任結果的完整指南

📄 許可證

• 免費使用場景：個人使用、開源項目、年收入低於 25,000 美元的初創公司和小企業。
• 商業許可證要求：年收入超過 25,000 美元的組織需要商業許可證。請查看 定價 獲取團隊和企業計劃，或查看 LICENSE 獲取完整條款。