@tastehub/ckb-linux-arm64 7.2.0 → 7.4.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 +182 -30
- package/bin/ckb +0 -0
- package/package.json +1 -1
package/bin/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# CKB — Code Knowledge Backend
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@tastehub/ckb)
|
|
4
|
+
[](https://codecov.io/gh/SimplyLiz/CodeMCP)
|
|
4
5
|
[](https://github.com/SimplyLiz/CodeMCP/wiki)
|
|
5
6
|
|
|
6
7
|
**The missing link between your codebase and AI assistants.**
|
|
@@ -139,34 +140,32 @@ Now Claude can answer questions like:
|
|
|
139
140
|
- **Hotspot Detection** — Track churn trends, get 30-day risk projections
|
|
140
141
|
- **Architectural Decisions** — Record and query ADRs with full-text search
|
|
141
142
|
|
|
142
|
-
###
|
|
143
|
-
- **Background Jobs** — Queue long operations, track progress, cancel jobs
|
|
144
|
-
- **CI/CD Integration** — PR risk analysis, ownership drift detection
|
|
145
|
-
|
|
146
|
-
### Cross-Repository (v6.2+)
|
|
143
|
+
### Advanced Capabilities
|
|
147
144
|
- **Federation** — Query across multiple repos organization-wide
|
|
148
|
-
- **
|
|
149
|
-
- **
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
- **
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
- **
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
- **
|
|
163
|
-
- **
|
|
164
|
-
- **
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
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+)
|
|
168
166
|
- **npm Distribution** — `npm install -g @tastehub/ckb` or `npx @tastehub/ckb`
|
|
169
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`)
|
|
170
169
|
|
|
171
170
|
### Zero-Index Operation (v7.1)
|
|
172
171
|
- **Tree-sitter Fallback** — Symbol search works without SCIP index (8 languages)
|
|
@@ -183,7 +182,36 @@ Now Claude can answer questions like:
|
|
|
183
182
|
- **Explicit Tiers** — Control analysis mode: `--tier=fast|standard|full` or `CKB_TIER` env var
|
|
184
183
|
- **Tier Diagnostics** — `ckb doctor --tier enhanced` shows exactly what's missing and how to fix it
|
|
185
184
|
|
|
186
|
-
|
|
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)
|
|
187
215
|
|
|
188
216
|
CKB exposes code intelligence through the Model Context Protocol:
|
|
189
217
|
|
|
@@ -275,6 +303,46 @@ CKB exposes code intelligence through the Model Context Protocol:
|
|
|
275
303
|
|
|
276
304
|
</details>
|
|
277
305
|
|
|
306
|
+
<details>
|
|
307
|
+
<summary><strong>v7.3 — Doc-Symbol Linking</strong></summary>
|
|
308
|
+
|
|
309
|
+
| Tool | Purpose |
|
|
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 |
|
|
317
|
+
|
|
318
|
+
</details>
|
|
319
|
+
|
|
320
|
+
<details>
|
|
321
|
+
<summary><strong>v7.3 — Multi-Repo Management</strong></summary>
|
|
322
|
+
|
|
323
|
+
| Tool | Purpose |
|
|
324
|
+
|------|---------|
|
|
325
|
+
| `listRepos` | List registered repos with state |
|
|
326
|
+
| `switchRepo` | Switch active repo context |
|
|
327
|
+
| `getActiveRepo` | Get current repo info |
|
|
328
|
+
|
|
329
|
+
</details>
|
|
330
|
+
|
|
331
|
+
<details>
|
|
332
|
+
<summary><strong>v7.3 — Remote Federation</strong></summary>
|
|
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
|
+
|
|
278
346
|
## CLI Usage
|
|
279
347
|
|
|
280
348
|
```bash
|
|
@@ -319,6 +387,12 @@ ckb federation add platform --repo-id=api --path=/code/api
|
|
|
319
387
|
ckb federation status platform
|
|
320
388
|
ckb federation sync platform
|
|
321
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
|
+
|
|
322
396
|
# Daemon (v6.2.1)
|
|
323
397
|
ckb daemon start [--port=9120]
|
|
324
398
|
ckb daemon status
|
|
@@ -357,6 +431,32 @@ curl "http://localhost:8080/search?q=NewServer"
|
|
|
357
431
|
curl http://localhost:8080/architecture
|
|
358
432
|
curl "http://localhost:8080/ownership?path=internal/api"
|
|
359
433
|
curl http://localhost:8080/hotspots
|
|
434
|
+
|
|
435
|
+
# Index Server Mode (v7.3) - serve indexes to remote clients
|
|
436
|
+
ckb serve --port 8080 --index-server --index-config config.toml
|
|
437
|
+
|
|
438
|
+
# Index server endpoints
|
|
439
|
+
curl http://localhost:8080/index/repos
|
|
440
|
+
curl http://localhost:8080/index/repos/company%2Fcore-lib/meta
|
|
441
|
+
curl "http://localhost:8080/index/repos/company%2Fcore-lib/symbols?limit=100"
|
|
442
|
+
curl "http://localhost:8080/index/repos/company%2Fcore-lib/search/symbols?q=Handler"
|
|
443
|
+
|
|
444
|
+
# Upload endpoints (with compression + auth)
|
|
445
|
+
curl -X POST http://localhost:8080/index/repos \
|
|
446
|
+
-H "Content-Type: application/json" \
|
|
447
|
+
-H "Authorization: Bearer ckb_xxx" \
|
|
448
|
+
-d '{"id":"my-org/my-repo","name":"My Repo"}'
|
|
449
|
+
|
|
450
|
+
gzip -c index.scip | curl -X POST http://localhost:8080/index/repos/my-org%2Fmy-repo/upload \
|
|
451
|
+
-H "Content-Encoding: gzip" \
|
|
452
|
+
-H "Authorization: Bearer ckb_xxx" \
|
|
453
|
+
--data-binary @-
|
|
454
|
+
|
|
455
|
+
# Token management (index server admin)
|
|
456
|
+
ckb token create --name "ci-upload" --scope upload # Create API key
|
|
457
|
+
ckb token list # List all tokens
|
|
458
|
+
ckb token revoke ckb_xxx # Revoke a token
|
|
459
|
+
ckb token rotate ckb_xxx # Rotate (new secret, same ID)
|
|
360
460
|
```
|
|
361
461
|
|
|
362
462
|
## MCP Integration
|
|
@@ -463,19 +563,31 @@ Add to `opencode.json` in project root:
|
|
|
463
563
|
<details>
|
|
464
564
|
<summary><strong>Claude Desktop</strong></summary>
|
|
465
565
|
|
|
466
|
-
|
|
566
|
+
Claude Desktop doesn't have a project context, so you must specify the repository path.
|
|
567
|
+
|
|
568
|
+
**Automatic setup** (recommended):
|
|
569
|
+
```bash
|
|
570
|
+
cd /path/to/your/repo
|
|
571
|
+
ckb setup --tool=claude-desktop
|
|
572
|
+
```
|
|
573
|
+
|
|
574
|
+
**Manual configuration** — add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
|
|
467
575
|
```json
|
|
468
576
|
{
|
|
469
577
|
"mcpServers": {
|
|
470
578
|
"ckb": {
|
|
471
579
|
"command": "npx",
|
|
472
|
-
"args": ["@tastehub/ckb", "mcp"],
|
|
473
|
-
"
|
|
580
|
+
"args": ["-y", "@tastehub/ckb", "mcp"],
|
|
581
|
+
"env": {
|
|
582
|
+
"CKB_REPO": "/path/to/your/repo"
|
|
583
|
+
}
|
|
474
584
|
}
|
|
475
585
|
}
|
|
476
586
|
}
|
|
477
587
|
```
|
|
478
588
|
|
|
589
|
+
The `CKB_REPO` environment variable tells CKB which repository to analyze. Claude Desktop can only work with one repository at a time.
|
|
590
|
+
|
|
479
591
|
</details>
|
|
480
592
|
|
|
481
593
|
<details>
|
|
@@ -495,6 +607,41 @@ Use `cmd /c` wrapper in any config above:
|
|
|
495
607
|
|
|
496
608
|
</details>
|
|
497
609
|
|
|
610
|
+
<details>
|
|
611
|
+
<summary><strong>Presets (Token Optimization)</strong></summary>
|
|
612
|
+
|
|
613
|
+
CKB exposes 76 tools, but most sessions only need a subset. Use presets to reduce token overhead by up to 83%:
|
|
614
|
+
|
|
615
|
+
```bash
|
|
616
|
+
# Default: core preset (14 essential tools)
|
|
617
|
+
ckb mcp
|
|
618
|
+
|
|
619
|
+
# Workflow-specific presets
|
|
620
|
+
ckb mcp --preset=core # 14 tools - search, explain, impact (default)
|
|
621
|
+
ckb mcp --preset=review # 19 tools - core + diff, ownership
|
|
622
|
+
ckb mcp --preset=refactor # 19 tools - core + coupling, dead code
|
|
623
|
+
ckb mcp --preset=federation # 28 tools - core + cross-repo
|
|
624
|
+
ckb mcp --preset=docs # 20 tools - core + doc-symbol linking
|
|
625
|
+
ckb mcp --preset=ops # 25 tools - core + jobs, webhooks, metrics
|
|
626
|
+
ckb mcp --preset=full # 76 tools - all tools (legacy)
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
In MCP config:
|
|
630
|
+
```json
|
|
631
|
+
{
|
|
632
|
+
"mcpServers": {
|
|
633
|
+
"ckb": {
|
|
634
|
+
"command": "npx",
|
|
635
|
+
"args": ["@tastehub/ckb", "mcp", "--preset=review"]
|
|
636
|
+
}
|
|
637
|
+
}
|
|
638
|
+
}
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
The AI can dynamically expand the toolset mid-session using the `expandToolset` tool.
|
|
642
|
+
|
|
643
|
+
</details>
|
|
644
|
+
|
|
498
645
|
## Under the Hood
|
|
499
646
|
|
|
500
647
|
CKB orchestrates multiple code intelligence backends:
|
|
@@ -528,9 +675,14 @@ See the **[Full Documentation Wiki](https://github.com/SimplyLiz/CodeMCP/wiki)**
|
|
|
528
675
|
- [Language Support](https://github.com/SimplyLiz/CodeMCP/wiki/Language-Support) — SCIP indexers and support tiers
|
|
529
676
|
- [Practical Limits](https://github.com/SimplyLiz/CodeMCP/wiki/Practical-Limits) — Accuracy notes, blind spots
|
|
530
677
|
- [User Guide](https://github.com/SimplyLiz/CodeMCP/wiki/User-Guide) — CLI commands and best practices
|
|
531
|
-
- [
|
|
678
|
+
- [Incremental Indexing](https://github.com/SimplyLiz/CodeMCP/wiki/Incremental-Indexing) — Fast index updates for Go projects
|
|
679
|
+
- [Doc-Symbol Linking](https://github.com/SimplyLiz/CodeMCP/wiki/Doc-Symbol-Linking) — Symbol detection in docs, staleness checking
|
|
680
|
+
- [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, 71 tools
|
|
532
682
|
- [API Reference](https://github.com/SimplyLiz/CodeMCP/wiki/API-Reference) — HTTP API documentation
|
|
683
|
+
- [Daemon Mode](https://github.com/SimplyLiz/CodeMCP/wiki/Daemon-Mode) — Always-on service with scheduler, webhooks
|
|
533
684
|
- [Configuration](https://github.com/SimplyLiz/CodeMCP/wiki/Configuration) — All options including MODULES.toml
|
|
685
|
+
- [Architecture](https://github.com/SimplyLiz/CodeMCP/wiki/Architecture) — System design and components
|
|
534
686
|
- [Telemetry](https://github.com/SimplyLiz/CodeMCP/wiki/Telemetry) — Runtime observability, dead code detection
|
|
535
687
|
- [Federation](https://github.com/SimplyLiz/CodeMCP/wiki/Federation) — Cross-repository queries
|
|
536
688
|
- [CI/CD Integration](https://github.com/SimplyLiz/CodeMCP/wiki/CI-CD-Integration) — GitHub Actions, PR analysis
|
package/bin/ckb
CHANGED
|
Binary file
|