@tastehub/ckb-linux-arm64 7.4.0 → 8.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/README.md +193 -307
- package/bin/ckb +0 -0
- package/package.json +1 -1
package/bin/README.md
CHANGED
|
@@ -1,68 +1,103 @@
|
|
|
1
1
|
# CKB — Code Knowledge Backend
|
|
2
2
|
|
|
3
|
+
**Know your code. Change it safely. Ship with confidence.**
|
|
4
|
+
|
|
3
5
|
[](https://www.npmjs.com/package/@tastehub/ckb)
|
|
4
|
-
[](https://codecov.io/gh/SimplyLiz/CodeMCP)
|
|
5
6
|
[](https://github.com/SimplyLiz/CodeMCP/wiki)
|
|
6
7
|
|
|
7
|
-
|
|
8
|
+
CKB transforms your codebase into a queryable knowledge base. Ask questions, understand impact, find owners, detect dead code—all through CLI, API, or AI assistants.
|
|
8
9
|
|
|
9
|
-
|
|
10
|
+
> Think of it as a senior engineer who knows every line of code, every decision, and every owner—available 24/7 to answer your questions.
|
|
10
11
|
|
|
11
|
-
|
|
12
|
+
---
|
|
12
13
|
|
|
13
|
-
##
|
|
14
|
+
## Instant Answers to Hard Questions
|
|
14
15
|
|
|
15
|
-
|
|
16
|
+
| Question | Without CKB | With CKB |
|
|
17
|
+
|----------|-------------|----------|
|
|
18
|
+
| "What breaks if I change this?" | Grep and hope | Precise blast radius with risk score |
|
|
19
|
+
| "Who should review this PR?" | Guess from git blame | Data-driven reviewer suggestions |
|
|
20
|
+
| "Is this code still used?" | Delete and see what breaks | Confidence-scored dead code detection |
|
|
21
|
+
| "What tests should I run?" | Run everything (30 min) | Run affected tests only (2 min) |
|
|
22
|
+
| "How does this system work?" | Read code for hours | Query architecture instantly |
|
|
23
|
+
| "Who owns this code?" | Search CODEOWNERS manually | Ownership with drift detection |
|
|
24
|
+
| "Are there exposed secrets?" | Manual grep for patterns | Automated scanning with 26 patterns |
|
|
16
25
|
|
|
17
|
-
|
|
18
|
-
1. Searches for text patterns (error-prone)
|
|
19
|
-
2. Reads random files hoping to find context (inefficient)
|
|
20
|
-
3. Gives up and asks you to provide more context (frustrating)
|
|
26
|
+
---
|
|
21
27
|
|
|
22
|
-
|
|
28
|
+
## What You Can Do
|
|
23
29
|
|
|
24
|
-
|
|
30
|
+
🔍 **Understand** — Semantic search, call graphs, usage tracing, architecture maps
|
|
25
31
|
|
|
26
|
-
|
|
32
|
+
⚡ **Analyze** — Impact analysis, risk scoring, hotspot detection, coupling analysis
|
|
27
33
|
|
|
28
|
-
|
|
34
|
+
🛡️ **Protect** — Affected test detection, breaking change warnings, PR risk assessment
|
|
29
35
|
|
|
30
|
-
|
|
36
|
+
🔐 **Secure** — Secret detection, credential scanning, security-sensitive code identification
|
|
31
37
|
|
|
32
|
-
|
|
33
|
-
You: "What's the impact of changing UserService.authenticate()?"
|
|
34
|
-
|
|
35
|
-
CKB provides:
|
|
36
|
-
├── Symbol details (signature, visibility, location)
|
|
37
|
-
├── 12 direct callers across 4 modules
|
|
38
|
-
├── Risk score: HIGH (public API, many dependents)
|
|
39
|
-
├── Affected modules: auth, api, admin, tests
|
|
40
|
-
├── Code owners: @security-team, @api-team
|
|
41
|
-
└── Suggested drilldowns for deeper analysis
|
|
42
|
-
```
|
|
38
|
+
👥 **Collaborate** — Ownership lookup, reviewer suggestions, architectural decisions (ADRs)
|
|
43
39
|
|
|
44
|
-
|
|
45
|
-
You: "Show me the architecture of this codebase"
|
|
46
|
-
|
|
47
|
-
CKB provides:
|
|
48
|
-
├── Module dependency graph
|
|
49
|
-
├── Key symbols per module
|
|
50
|
-
├── Module responsibilities and ownership
|
|
51
|
-
├── Import/export relationships
|
|
52
|
-
└── Compressed to fit LLM context
|
|
53
|
-
```
|
|
40
|
+
📊 **Improve** — Dead code detection, tech debt tracking, documentation coverage
|
|
54
41
|
|
|
42
|
+
🚀 **Compound Operations** — Single-call tools (`explore`, `understand`, `prepareChange`) reduce AI tool calls by 60-70%
|
|
43
|
+
|
|
44
|
+
🔗 **Integrate** — CLI, HTTP API, MCP for AI tools, CI/CD pipelines, custom scripts
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Try It Now
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
# See what's risky in your codebase
|
|
52
|
+
ckb hotspots
|
|
53
|
+
|
|
54
|
+
# Check impact before changing code
|
|
55
|
+
ckb impact diff
|
|
56
|
+
|
|
57
|
+
# Find tests to run for your changes
|
|
58
|
+
ckb affected-tests --output=command
|
|
59
|
+
|
|
60
|
+
# Scan for exposed secrets
|
|
61
|
+
ckb scan-secrets
|
|
62
|
+
|
|
63
|
+
# Get reviewers for your PR
|
|
64
|
+
ckb reviewers
|
|
65
|
+
|
|
66
|
+
# Check architecture at a glance
|
|
67
|
+
ckb arch
|
|
55
68
|
```
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## Works Everywhere
|
|
73
|
+
|
|
74
|
+
| AI Assistants | CI/CD | Your Tools |
|
|
75
|
+
|---------------|-------|------------|
|
|
76
|
+
| Claude Code, Cursor, Windsurf, VS Code | GitHub Actions, GitLab CI | CLI, HTTP API, Scripts |
|
|
77
|
+
|
|
78
|
+
**83% token reduction** with smart presets—load only the tools you need.
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
# One command to connect to Claude Code
|
|
82
|
+
ckb setup
|
|
64
83
|
```
|
|
65
84
|
|
|
85
|
+
> **Building your own tools?** Use CKB as a backend via CLI, HTTP API, or MCP. See the **[Integration Guide](https://github.com/SimplyLiz/CodeMCP/wiki/Integration-Guide)** for examples in Node.js, Python, Go, and shell scripts.
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## Learn More
|
|
90
|
+
|
|
91
|
+
| Resource | Description |
|
|
92
|
+
|----------|-------------|
|
|
93
|
+
| 📖 **[Features Guide](https://github.com/SimplyLiz/CodeMCP/wiki/Features)** | Complete feature list with examples |
|
|
94
|
+
| 💬 **[Prompt Cookbook](https://github.com/SimplyLiz/CodeMCP/wiki/Prompt-Cookbook)** | Real prompts for real problems |
|
|
95
|
+
| 🔌 **[Integration Guide](https://github.com/SimplyLiz/CodeMCP/wiki/Integration-Guide)** | Use CKB in your own tools and scripts |
|
|
96
|
+
| ⚡ **[Impact Analysis](https://github.com/SimplyLiz/CodeMCP/wiki/Impact-Analysis)** | Blast radius, affected tests, PR risk |
|
|
97
|
+
| 🔧 **[CI/CD Integration](https://github.com/SimplyLiz/CodeMCP/wiki/CI-CD-Integration)** | GitHub Actions, GitLab CI templates |
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
66
101
|
## Quick Start
|
|
67
102
|
|
|
68
103
|
### Option 1: npm (Recommended)
|
|
@@ -100,6 +135,14 @@ ckb setup # creates .mcp.json automatically
|
|
|
100
135
|
claude mcp add --transport stdio ckb -- npx @tastehub/ckb mcp
|
|
101
136
|
```
|
|
102
137
|
|
|
138
|
+
**Token efficiency shown at startup:**
|
|
139
|
+
```
|
|
140
|
+
CKB MCP Server v8.0.0
|
|
141
|
+
Active tools: 14 / 76 (18%)
|
|
142
|
+
Estimated context: ~1k tokens
|
|
143
|
+
Preset: core
|
|
144
|
+
```
|
|
145
|
+
|
|
103
146
|
Now Claude can answer questions like:
|
|
104
147
|
- *"What calls the HandleRequest function?"*
|
|
105
148
|
- *"How is ProcessPayment reached from the API?"*
|
|
@@ -126,297 +169,117 @@ Now Claude can answer questions like:
|
|
|
126
169
|
| **[CLI](https://github.com/SimplyLiz/CodeMCP/wiki/User-Guide)** | Quick lookups from terminal, scripting |
|
|
127
170
|
| **[HTTP API](https://github.com/SimplyLiz/CodeMCP/wiki/API-Reference)** | IDE plugins, CI integration, custom tooling |
|
|
128
171
|
|
|
129
|
-
##
|
|
130
|
-
|
|
131
|
-
### Core Intelligence
|
|
132
|
-
- **Symbol Navigation** — Find any function, class, or variable in milliseconds
|
|
133
|
-
- **Call Flow & Tracing** — Trace how code is reached from API endpoints, CLI commands, or jobs
|
|
134
|
-
- **Impact Analysis** — Know exactly what breaks before refactoring, with risk scores
|
|
135
|
-
- **Architecture Maps** — Module dependency graphs, responsibilities, domain concepts
|
|
136
|
-
- **Dead Code Detection** — Keep/investigate/remove verdicts based on usage analysis
|
|
137
|
-
|
|
138
|
-
### Ownership & Risk
|
|
139
|
-
- **Ownership Intelligence** — CODEOWNERS + git blame with time-weighted analysis
|
|
140
|
-
- **Hotspot Detection** — Track churn trends, get 30-day risk projections
|
|
141
|
-
- **Architectural Decisions** — Record and query ADRs with full-text search
|
|
142
|
-
|
|
143
|
-
### Advanced Capabilities
|
|
144
|
-
- **Federation** — Query across multiple repos organization-wide
|
|
145
|
-
- **Multi-Repo Management** — Named repo registry with quick MCP context switching
|
|
146
|
-
- **Daemon Mode** — Always-on service with HTTP API, scheduled tasks, webhooks
|
|
147
|
-
- **Contract Analysis** — Protobuf and OpenAPI discovery with cross-repo impact
|
|
148
|
-
- **Runtime Observability** — OpenTelemetry integration for dead code detection
|
|
149
|
-
- **Developer Intelligence** — Symbol origins, co-change coupling, risk audit
|
|
150
|
-
|
|
151
|
-
### Fast Indexing
|
|
152
|
-
- **Zero-Index Operation** — Tree-sitter fallback works without SCIP index
|
|
153
|
-
- **Incremental Updates** — O(changed files) instead of full reindex (Go)
|
|
154
|
-
- **Smart Caching** — Skip-if-fresh, watch mode, transitive invalidation
|
|
155
|
-
|
|
156
|
-
### Remote Index Server
|
|
157
|
-
- **Index Serving** — Serve symbol indexes over HTTP for federation
|
|
158
|
-
- **Index Upload** — Push SCIP indexes with compression (gzip/zstd)
|
|
159
|
-
- **Delta Updates** — Upload only changed files
|
|
160
|
-
- **API Key Auth** — Scoped keys with rate limiting
|
|
161
|
-
- **Remote Federation** — Connect to remote CKB servers and query alongside local repos
|
|
162
|
-
|
|
163
|
-
📋 **[Full Changelog](https://github.com/SimplyLiz/CodeMCP/blob/main/CHANGELOG.md)** — Detailed version history from v5.1 to current
|
|
164
|
-
|
|
165
|
-
### Zero-Friction UX (v7.0+)
|
|
166
|
-
- **npm Distribution** — `npm install -g @tastehub/ckb` or `npx @tastehub/ckb`
|
|
167
|
-
- **Auto-Setup** — `ckb setup` configures Claude Code integration automatically
|
|
168
|
-
- **Update Notifications** — Automatic update check for npm installs (disable with `CKB_NO_UPDATE_CHECK=1`)
|
|
169
|
-
|
|
170
|
-
### Zero-Index Operation (v7.1)
|
|
171
|
-
- **Tree-sitter Fallback** — Symbol search works without SCIP index (8 languages)
|
|
172
|
-
- **Auto-Index** — `ckb index` detects language and runs the right SCIP indexer
|
|
173
|
-
- **Install Guidance** — Shows indexer install commands when missing
|
|
174
|
-
- **Universal MCP Docs** — Setup for Claude Code, Cursor, Windsurf, VS Code, OpenCode, Claude Desktop
|
|
175
|
-
|
|
176
|
-
### Smart Indexing & Explicit Tiers (v7.2)
|
|
177
|
-
- **Skip-if-Fresh** — `ckb index` automatically skips if index is current with HEAD
|
|
178
|
-
- **Freshness Tracking** — Tracks commits behind HEAD + uncommitted changes
|
|
179
|
-
- **Index Status** — `ckb status` shows index freshness with commit hash
|
|
180
|
-
- **Watch Mode** — `ckb mcp --watch` polls every 30s and auto-reindexes when stale
|
|
181
|
-
- **Lock File** — Prevents concurrent indexing with flock-based locking
|
|
182
|
-
- **Explicit Tiers** — Control analysis mode: `--tier=fast|standard|full` or `CKB_TIER` env var
|
|
183
|
-
- **Tier Diagnostics** — `ckb doctor --tier enhanced` shows exactly what's missing and how to fix it
|
|
184
|
-
|
|
185
|
-
### Doc-Symbol Linking (v7.3)
|
|
186
|
-
- **Backtick Detection** — Automatically detect `Symbol.Name` references in markdown
|
|
187
|
-
- **Directive Support** — Explicit `<!-- ckb:symbol -->` and `<!-- ckb:module -->` directives
|
|
188
|
-
- **Fence Scanning** — Extract symbols from fenced code blocks via tree-sitter (8 languages)
|
|
189
|
-
- **Staleness Detection** — Find broken references when symbols are renamed or deleted
|
|
190
|
-
- **Rename Awareness** — Suggest new names when documented symbols are renamed
|
|
191
|
-
- **CI Enforcement** — `--fail-under` flag for documentation coverage thresholds
|
|
192
|
-
|
|
193
|
-
### Standardized Response Envelope (v7.4)
|
|
194
|
-
- **Unified Metadata** — All 76 MCP tool responses now include structured metadata
|
|
195
|
-
- **Confidence Tiers** — High/Medium/Low/Speculative tiers based on data freshness and source
|
|
196
|
-
- **Provenance Tracking** — Know which backends (SCIP, Git, LSP) contributed to results
|
|
197
|
-
- **Truncation Awareness** — Metadata shows when results are truncated and total counts
|
|
198
|
-
- **Suggested Next Calls** — Structured drilldown suggestions for follow-up queries
|
|
199
|
-
|
|
200
|
-
### Production Hardening (v7.3)
|
|
201
|
-
- **Delta Artifacts** — CI-generated diffs for O(delta) ingestion instead of O(N)
|
|
202
|
-
- **FTS5 Search** — SQLite FTS5 for instant search (replaces LIKE scans)
|
|
203
|
-
- **Compaction Scheduler** — Automatic snapshot cleanup and database maintenance
|
|
204
|
-
- **Prometheus Metrics** — `/metrics` endpoint for monitoring and alerting
|
|
205
|
-
- **Load Shedding** — Graceful degradation under load with priority endpoints
|
|
206
|
-
- **Health Details** — `/health/detailed` endpoint with per-repo and storage metrics
|
|
207
|
-
|
|
208
|
-
### Language Quality (v7.3)
|
|
209
|
-
- **Quality Tiers** — 4-tier classification (Tier 1: Go, Tier 2: TS/Python, Tier 3: Rust/Java, Tier 4: Experimental)
|
|
210
|
-
- **Quality Assessment** — Per-language metrics (ref accuracy, callgraph quality)
|
|
211
|
-
- **Python Venv Detection** — Auto-detect virtual environments with activation recommendations
|
|
212
|
-
- **TypeScript Monorepo** — Detect pnpm, lerna, nx, yarn workspaces with per-package tsconfig status
|
|
213
|
-
|
|
214
|
-
## MCP Tools (74 Available)
|
|
215
|
-
|
|
216
|
-
CKB exposes code intelligence through the Model Context Protocol:
|
|
217
|
-
|
|
218
|
-
<details>
|
|
219
|
-
<summary><strong>v5.1 — Core Navigation</strong></summary>
|
|
220
|
-
|
|
221
|
-
| Tool | Purpose |
|
|
222
|
-
|------|---------|
|
|
223
|
-
| `searchSymbols` | Find symbols by name with filtering |
|
|
224
|
-
| `getSymbol` | Get symbol details |
|
|
225
|
-
| `findReferences` | Find all usages |
|
|
226
|
-
| `explainSymbol` | AI-friendly symbol explanation |
|
|
227
|
-
| `justifySymbol` | Keep/investigate/remove verdict |
|
|
228
|
-
| `getCallGraph` | Caller/callee relationships |
|
|
229
|
-
| `getModuleOverview` | Module statistics |
|
|
230
|
-
| `analyzeImpact` | Change risk analysis |
|
|
231
|
-
| `getStatus` | System health |
|
|
232
|
-
| `doctor` | Diagnostics |
|
|
233
|
-
|
|
234
|
-
</details>
|
|
235
|
-
|
|
236
|
-
<details>
|
|
237
|
-
<summary><strong>v5.2 — Discovery & Flow</strong></summary>
|
|
238
|
-
|
|
239
|
-
| Tool | Purpose |
|
|
240
|
-
|------|---------|
|
|
241
|
-
| `traceUsage` | How is this symbol reached? |
|
|
242
|
-
| `listEntrypoints` | System entrypoints (API, CLI, jobs) |
|
|
243
|
-
| `explainFile` | File-level orientation |
|
|
244
|
-
| `explainPath` | Why does this path exist? |
|
|
245
|
-
| `summarizeDiff` | What changed, what might break? |
|
|
246
|
-
| `getArchitecture` | Module dependency overview |
|
|
247
|
-
| `getHotspots` | Volatile areas with trends |
|
|
248
|
-
| `listKeyConcepts` | Domain concepts in codebase |
|
|
249
|
-
| `recentlyRelevant` | What matters now? |
|
|
172
|
+
## How Indexing Works
|
|
250
173
|
|
|
251
|
-
|
|
174
|
+
CKB uses **SCIP indexes** to understand your code. Think of it like a database that knows where every function is defined, who calls it, and how everything connects.
|
|
252
175
|
|
|
253
|
-
|
|
254
|
-
<summary><strong>v6.0 — Architectural Memory</strong></summary>
|
|
176
|
+
### The Basics
|
|
255
177
|
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
| `getModuleResponsibilities` | What does this module do? |
|
|
260
|
-
| `recordDecision` | Create an ADR |
|
|
261
|
-
| `getDecisions` | Query architectural decisions |
|
|
262
|
-
| `annotateModule` | Add module metadata |
|
|
263
|
-
| `refreshArchitecture` | Rebuild architectural model |
|
|
178
|
+
```bash
|
|
179
|
+
# 1. Generate an index (auto-detects language)
|
|
180
|
+
ckb index
|
|
264
181
|
|
|
265
|
-
|
|
182
|
+
# 2. Check if your index is fresh
|
|
183
|
+
ckb status
|
|
184
|
+
```
|
|
266
185
|
|
|
267
|
-
|
|
268
|
-
|
|
186
|
+
Without an index, CKB still works using tree-sitter parsing (basic mode), but with an index you get:
|
|
187
|
+
- Cross-file references ("who calls this function?")
|
|
188
|
+
- Precise impact analysis
|
|
189
|
+
- Call graph navigation
|
|
269
190
|
|
|
270
|
-
|
|
271
|
-
|------|---------|
|
|
272
|
-
| `getJobStatus` | Query background job status |
|
|
273
|
-
| `listJobs` | List jobs with filters |
|
|
274
|
-
| `cancelJob` | Cancel queued/running job |
|
|
275
|
-
| `summarizePr` | PR risk analysis & reviewers |
|
|
276
|
-
| `getOwnershipDrift` | CODEOWNERS vs actual ownership |
|
|
191
|
+
### Language Support
|
|
277
192
|
|
|
278
|
-
|
|
193
|
+
Not all languages are equal. CKB classifies languages into **quality tiers** based on indexer maturity:
|
|
279
194
|
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
|
284
|
-
|
|
285
|
-
|
|
|
286
|
-
| `federationStatus` | Get federation status |
|
|
287
|
-
| `federationSearchModules` | Cross-repo module search |
|
|
288
|
-
| `federationSearchOwnership` | Cross-repo ownership search |
|
|
289
|
-
| `federationGetHotspots` | Merged hotspots across repos |
|
|
290
|
-
| `daemonStatus` | Daemon health and stats |
|
|
291
|
-
| `listSchedules` | List scheduled tasks |
|
|
292
|
-
| `listWebhooks` | List configured webhooks |
|
|
293
|
-
| `getFileComplexity` | Cyclomatic/cognitive complexity |
|
|
294
|
-
| `listContracts` | List contracts in federation |
|
|
295
|
-
| `analyzeContractImpact` | Contract change impact |
|
|
296
|
-
| `getTelemetryStatus` | Coverage metrics and sync status |
|
|
297
|
-
| `getObservedUsage` | Observed usage for a symbol |
|
|
298
|
-
| `findDeadCodeCandidates` | Zero runtime call detection |
|
|
299
|
-
| `explainOrigin` | Why does this code exist? |
|
|
300
|
-
| `analyzeCoupling` | Co-change analysis |
|
|
301
|
-
| `exportForLLM` | LLM-friendly export |
|
|
302
|
-
| `auditRisk` | Multi-signal risk audit |
|
|
195
|
+
| Tier | Quality | Languages |
|
|
196
|
+
|------|---------|-----------|
|
|
197
|
+
| **Tier 1** | Full support, all features | Go |
|
|
198
|
+
| **Tier 2** | Full support, minor edge cases | TypeScript, JavaScript, Python |
|
|
199
|
+
| **Tier 3** | Basic support, call graph may be incomplete | Rust, Java, Kotlin, C++, Ruby, Dart |
|
|
200
|
+
| **Tier 4** | Experimental | C#, PHP |
|
|
303
201
|
|
|
304
|
-
|
|
202
|
+
**Key limitations:**
|
|
203
|
+
- **Incremental indexing** is Go-only. Other languages require full reindex.
|
|
204
|
+
- **TypeScript monorepos** may need `--infer-tsconfig` flag
|
|
205
|
+
- **C/C++** requires `compile_commands.json`
|
|
206
|
+
- **Python** works best with activated virtual environment
|
|
305
207
|
|
|
306
|
-
|
|
307
|
-
<summary><strong>v7.3 — Doc-Symbol Linking</strong></summary>
|
|
208
|
+
Run `ckb doctor --tier standard` to check if your language tools are properly installed.
|
|
308
209
|
|
|
309
|
-
|
|
310
|
-
|------|---------|
|
|
311
|
-
| `indexDocs` | Scan and index documentation |
|
|
312
|
-
| `getDocsForSymbol` | Find docs referencing a symbol |
|
|
313
|
-
| `getSymbolsInDoc` | List symbols in a document |
|
|
314
|
-
| `getDocsForModule` | Find docs linked to a module |
|
|
315
|
-
| `checkDocStaleness` | Check for stale references |
|
|
316
|
-
| `getDocCoverage` | Documentation coverage stats |
|
|
210
|
+
See **[Language Support](https://github.com/SimplyLiz/CodeMCP/wiki/Language-Support)** for indexer installation, known issues, and the full feature matrix.
|
|
317
211
|
|
|
318
|
-
|
|
212
|
+
### Keeping Your Index Fresh
|
|
319
213
|
|
|
320
|
-
|
|
321
|
-
<summary><strong>v7.3 — Multi-Repo Management</strong></summary>
|
|
214
|
+
Your index becomes stale when you make commits. CKB offers several ways to stay current:
|
|
322
215
|
|
|
323
|
-
|
|
|
324
|
-
|
|
325
|
-
| `
|
|
326
|
-
| `
|
|
327
|
-
| `
|
|
216
|
+
| Method | Command | When to Use |
|
|
217
|
+
|--------|---------|-------------|
|
|
218
|
+
| Manual | `ckb index` | One-off updates, scripts |
|
|
219
|
+
| Watch mode | `ckb index --watch` | Auto-refresh during development |
|
|
220
|
+
| MCP watch | `ckb mcp --watch` | Auto-refresh in AI sessions |
|
|
221
|
+
| CI webhook | `POST /api/v1/refresh` | Trigger from CI/CD |
|
|
328
222
|
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
| Tool | Purpose |
|
|
335
|
-
|------|---------|
|
|
336
|
-
| `federationAddRemote` | Add a remote CKB index server |
|
|
337
|
-
| `federationRemoveRemote` | Remove a remote server |
|
|
338
|
-
| `federationListRemote` | List remote servers in federation |
|
|
339
|
-
| `federationSyncRemote` | Sync metadata from remote servers |
|
|
340
|
-
| `federationStatusRemote` | Check remote server connectivity |
|
|
341
|
-
| `federationSearchSymbolsHybrid` | Search across local + remote |
|
|
342
|
-
| `federationListAllRepos` | List repos from local and remote |
|
|
343
|
-
|
|
344
|
-
</details>
|
|
345
|
-
|
|
346
|
-
## CLI Usage
|
|
223
|
+
**Quick start for AI sessions:**
|
|
224
|
+
```bash
|
|
225
|
+
ckb mcp --watch # Auto-reindexes every 30s when stale
|
|
226
|
+
```
|
|
347
227
|
|
|
228
|
+
**Check staleness:**
|
|
348
229
|
```bash
|
|
349
|
-
# System status
|
|
350
230
|
ckb status
|
|
231
|
+
# Shows: "5 commits behind HEAD" or "Up to date"
|
|
232
|
+
```
|
|
351
233
|
|
|
352
|
-
|
|
353
|
-
ckb search NewServer
|
|
234
|
+
For Go projects, CKB uses **incremental indexing**—only changed files are processed, making updates fast.
|
|
354
235
|
|
|
355
|
-
|
|
356
|
-
ckb refs NewServer
|
|
236
|
+
See the **[Index Management Guide](https://github.com/SimplyLiz/CodeMCP/wiki/Index-Management)** for complete documentation.
|
|
357
237
|
|
|
358
|
-
|
|
359
|
-
ckb arch
|
|
360
|
-
|
|
361
|
-
# Analyze change impact
|
|
362
|
-
ckb impact <symbol-id>
|
|
238
|
+
## Features
|
|
363
239
|
|
|
364
|
-
|
|
365
|
-
|
|
240
|
+
| Feature | Description |
|
|
241
|
+
|---------|-------------|
|
|
242
|
+
| [**Compound Operations**](https://github.com/SimplyLiz/CodeMCP/wiki/Features#compound-operations) | `explore`, `understand`, `prepareChange` — single-call tools that reduce AI overhead by 60-70% |
|
|
243
|
+
| [**Code Navigation**](https://github.com/SimplyLiz/CodeMCP/wiki/Features#code-navigation--discovery) | Semantic search, call graphs, trace usage, find entrypoints |
|
|
244
|
+
| [**Impact Analysis**](https://github.com/SimplyLiz/CodeMCP/wiki/Features#impact-analysis--safety) | Blast radius, risk scoring, affected tests, breaking changes (`compareAPI`) |
|
|
245
|
+
| [**Architecture**](https://github.com/SimplyLiz/CodeMCP/wiki/Features#architectural-understanding) | Module overview, ADRs, dependency graphs, explain origin |
|
|
246
|
+
| [**Ownership**](https://github.com/SimplyLiz/CodeMCP/wiki/Features#ownership--review) | CODEOWNERS + git blame, reviewer suggestions, drift detection |
|
|
247
|
+
| [**Code Quality**](https://github.com/SimplyLiz/CodeMCP/wiki/Features#code-quality--risk) | Dead code detection (`findDeadCode`), coupling analysis, complexity |
|
|
248
|
+
| [**Security**](https://github.com/SimplyLiz/CodeMCP/wiki/Security) | Secret detection, credential scanning, allowlists |
|
|
249
|
+
| [**Documentation**](https://github.com/SimplyLiz/CodeMCP/wiki/Features#documentation-intelligence) | Doc-symbol linking, staleness detection, coverage metrics |
|
|
250
|
+
| [**Multi-Repo**](https://github.com/SimplyLiz/CodeMCP/wiki/Features#multi-repo--federation) | Federation, API contracts, remote index serving |
|
|
251
|
+
| [**Runtime**](https://github.com/SimplyLiz/CodeMCP/wiki/Features#runtime-intelligence) | OpenTelemetry integration, observed usage, production dead code |
|
|
252
|
+
| [**Streaming**](https://github.com/SimplyLiz/CodeMCP/wiki/Features#streaming) | SSE streaming for `findReferences`, `searchSymbols` with real-time progress |
|
|
253
|
+
| [**Automation**](https://github.com/SimplyLiz/CodeMCP/wiki/Features#automation--cicd) | Daemon mode, watch mode, webhooks, incremental indexing |
|
|
366
254
|
|
|
367
|
-
|
|
368
|
-
ckb decisions
|
|
255
|
+
📖 **[Full Features Guide](https://github.com/SimplyLiz/CodeMCP/wiki/Features)** — Detailed documentation with examples
|
|
369
256
|
|
|
370
|
-
|
|
371
|
-
ckb doctor
|
|
257
|
+
📋 **[Changelog](https://github.com/SimplyLiz/CodeMCP/blob/main/CHANGELOG.md)** — Version history
|
|
372
258
|
|
|
373
|
-
|
|
374
|
-
ckb doctor --tier enhanced
|
|
259
|
+
## CLI
|
|
375
260
|
|
|
376
|
-
|
|
377
|
-
ckb
|
|
261
|
+
```bash
|
|
262
|
+
ckb status # System health (with remediation suggestions)
|
|
263
|
+
ckb search Handler # Find symbols
|
|
264
|
+
ckb impact diff # Analyze changes
|
|
265
|
+
ckb affected-tests # Tests to run
|
|
266
|
+
ckb hotspots # Risky areas
|
|
267
|
+
ckb arch # Architecture overview
|
|
268
|
+
ckb reviewers # PR reviewers
|
|
269
|
+
ckb mcp # Start MCP server
|
|
378
270
|
```
|
|
379
271
|
|
|
380
|
-
|
|
381
|
-
<summary><strong>More CLI commands</strong></summary>
|
|
382
|
-
|
|
272
|
+
**v8.0 Compound Operations (via MCP):**
|
|
383
273
|
```bash
|
|
384
|
-
#
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
# Remote Federation (v7.3)
|
|
391
|
-
ckb federation add-remote platform prod --url=https://ckb.company.com --token=$CKB_TOKEN
|
|
392
|
-
ckb federation list-remote platform
|
|
393
|
-
ckb federation sync-remote platform
|
|
394
|
-
ckb federation status-remote platform prod
|
|
395
|
-
|
|
396
|
-
# Daemon (v6.2.1)
|
|
397
|
-
ckb daemon start [--port=9120]
|
|
398
|
-
ckb daemon status
|
|
399
|
-
ckb daemon logs --follow
|
|
400
|
-
ckb daemon stop
|
|
401
|
-
|
|
402
|
-
# Contracts (v6.3)
|
|
403
|
-
ckb contracts list platform
|
|
404
|
-
ckb contracts impact platform --repo=api --path=proto/api/v1/user.proto
|
|
405
|
-
ckb contracts deps platform --repo=api
|
|
406
|
-
|
|
407
|
-
# Telemetry (v6.4)
|
|
408
|
-
ckb telemetry status
|
|
409
|
-
ckb telemetry usage --symbol="internal/api/handler.go:HandleRequest"
|
|
410
|
-
ckb dead-code --min-confidence=0.7
|
|
411
|
-
|
|
412
|
-
# Developer Intelligence (v6.5)
|
|
413
|
-
ckb explain internal/api/handler.go:42
|
|
414
|
-
ckb coupling internal/query/engine.go --min-correlation=0.5
|
|
415
|
-
ckb export --min-complexity=10 --max-symbols=200
|
|
416
|
-
ckb audit --min-score=60 --quick-wins
|
|
274
|
+
# These tools combine multiple queries into single calls
|
|
275
|
+
explore # Area exploration: symbols, dependencies, hotspots
|
|
276
|
+
understand # Symbol deep-dive: refs, callers, explanation
|
|
277
|
+
prepareChange # Pre-change analysis: impact, tests, risk
|
|
278
|
+
batchGet # Fetch up to 50 symbols at once
|
|
279
|
+
batchSearch # Run up to 10 searches at once
|
|
417
280
|
```
|
|
418
281
|
|
|
419
|
-
|
|
282
|
+
📖 **[User Guide](https://github.com/SimplyLiz/CodeMCP/wiki/User-Guide)** — All CLI commands and options
|
|
420
283
|
|
|
421
284
|
## HTTP API
|
|
422
285
|
|
|
@@ -610,9 +473,12 @@ Use `cmd /c` wrapper in any config above:
|
|
|
610
473
|
<details>
|
|
611
474
|
<summary><strong>Presets (Token Optimization)</strong></summary>
|
|
612
475
|
|
|
613
|
-
CKB exposes
|
|
476
|
+
CKB exposes 80+ tools, but most sessions only need a subset. Use presets to reduce token overhead by up to 83%:
|
|
614
477
|
|
|
615
478
|
```bash
|
|
479
|
+
# List all available presets with tool counts and token estimates
|
|
480
|
+
ckb mcp --list-presets
|
|
481
|
+
|
|
616
482
|
# Default: core preset (14 essential tools)
|
|
617
483
|
ckb mcp
|
|
618
484
|
|
|
@@ -623,7 +489,7 @@ ckb mcp --preset=refactor # 19 tools - core + coupling, dead code
|
|
|
623
489
|
ckb mcp --preset=federation # 28 tools - core + cross-repo
|
|
624
490
|
ckb mcp --preset=docs # 20 tools - core + doc-symbol linking
|
|
625
491
|
ckb mcp --preset=ops # 25 tools - core + jobs, webhooks, metrics
|
|
626
|
-
ckb mcp --preset=full #
|
|
492
|
+
ckb mcp --preset=full # 80+ tools - all tools (legacy)
|
|
627
493
|
```
|
|
628
494
|
|
|
629
495
|
In MCP config:
|
|
@@ -666,6 +532,24 @@ Persistent knowledge survives across sessions:
|
|
|
666
532
|
- **Code reviewers** — See the full picture of changes
|
|
667
533
|
- **Tech leads** — Track architectural health over time
|
|
668
534
|
|
|
535
|
+
## Limitations (Honest Take)
|
|
536
|
+
|
|
537
|
+
**CKB excels at:**
|
|
538
|
+
- Static code navigation—finding definitions, references, call graphs
|
|
539
|
+
- Impact analysis for safe refactoring
|
|
540
|
+
- Ownership lookup (CODEOWNERS + git blame)
|
|
541
|
+
- Architecture and module understanding
|
|
542
|
+
|
|
543
|
+
**CKB won't help with:**
|
|
544
|
+
- Dynamic dispatch / runtime behavior (use debugger)
|
|
545
|
+
- Generated code that isn't indexed
|
|
546
|
+
- Code generation, linting, or formatting
|
|
547
|
+
- Cross-repo calls (use [federation](https://github.com/SimplyLiz/CodeMCP/wiki/Federation) for this)
|
|
548
|
+
|
|
549
|
+
> CKB is static analysis, not magic. Always verify critical decisions by reading the actual code.
|
|
550
|
+
|
|
551
|
+
📖 **[Practical Limits](https://github.com/SimplyLiz/CodeMCP/wiki/Practical-Limits)** — Full guide on accuracy, blind spots, and when to trust results
|
|
552
|
+
|
|
669
553
|
## Documentation
|
|
670
554
|
|
|
671
555
|
See the **[Full Documentation Wiki](https://github.com/SimplyLiz/CodeMCP/wiki)** for:
|
|
@@ -675,14 +559,16 @@ See the **[Full Documentation Wiki](https://github.com/SimplyLiz/CodeMCP/wiki)**
|
|
|
675
559
|
- [Language Support](https://github.com/SimplyLiz/CodeMCP/wiki/Language-Support) — SCIP indexers and support tiers
|
|
676
560
|
- [Practical Limits](https://github.com/SimplyLiz/CodeMCP/wiki/Practical-Limits) — Accuracy notes, blind spots
|
|
677
561
|
- [User Guide](https://github.com/SimplyLiz/CodeMCP/wiki/User-Guide) — CLI commands and best practices
|
|
562
|
+
- [Index Management](https://github.com/SimplyLiz/CodeMCP/wiki/Index-Management) — How indexing works, auto-refresh methods
|
|
678
563
|
- [Incremental Indexing](https://github.com/SimplyLiz/CodeMCP/wiki/Incremental-Indexing) — Fast index updates for Go projects
|
|
679
564
|
- [Doc-Symbol Linking](https://github.com/SimplyLiz/CodeMCP/wiki/Doc-Symbol-Linking) — Symbol detection in docs, staleness checking
|
|
680
565
|
- [Authentication](https://github.com/SimplyLiz/CodeMCP/wiki/Authentication) — API tokens, scopes, rate limiting
|
|
681
|
-
- [MCP Integration](https://github.com/SimplyLiz/CodeMCP/wiki/MCP-Integration) — Claude Code setup,
|
|
566
|
+
- [MCP Integration](https://github.com/SimplyLiz/CodeMCP/wiki/MCP-Integration) — Claude Code setup, 80+ tools
|
|
682
567
|
- [API Reference](https://github.com/SimplyLiz/CodeMCP/wiki/API-Reference) — HTTP API documentation
|
|
683
568
|
- [Daemon Mode](https://github.com/SimplyLiz/CodeMCP/wiki/Daemon-Mode) — Always-on service with scheduler, webhooks
|
|
684
569
|
- [Configuration](https://github.com/SimplyLiz/CodeMCP/wiki/Configuration) — All options including MODULES.toml
|
|
685
570
|
- [Architecture](https://github.com/SimplyLiz/CodeMCP/wiki/Architecture) — System design and components
|
|
571
|
+
- [Security](https://github.com/SimplyLiz/CodeMCP/wiki/Security) — Secret detection, credential scanning
|
|
686
572
|
- [Telemetry](https://github.com/SimplyLiz/CodeMCP/wiki/Telemetry) — Runtime observability, dead code detection
|
|
687
573
|
- [Federation](https://github.com/SimplyLiz/CodeMCP/wiki/Federation) — Cross-repository queries
|
|
688
574
|
- [CI/CD Integration](https://github.com/SimplyLiz/CodeMCP/wiki/CI-CD-Integration) — GitHub Actions, PR analysis
|
package/bin/ckb
CHANGED
|
Binary file
|