@tastehub/ckb-darwin-arm64 7.0.0 → 7.2.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 +188 -23
- package/bin/ckb +0 -0
- package/package.json +1 -1
package/bin/README.md
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
# CKB — Code Knowledge Backend
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@tastehub/ckb)
|
|
4
|
+
[](https://github.com/SimplyLiz/CodeMCP/wiki)
|
|
5
|
+
|
|
3
6
|
**The missing link between your codebase and AI assistants.**
|
|
4
7
|
|
|
5
8
|
CKB gives AI assistants deep understanding of your code. Instead of grepping through files, your AI can now *navigate* code like a senior engineer—with knowledge of who owns what, what's risky to change, and how everything connects.
|
|
@@ -61,22 +64,39 @@ CKB provides:
|
|
|
61
64
|
|
|
62
65
|
## Quick Start
|
|
63
66
|
|
|
67
|
+
### Option 1: npm (Recommended)
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
# Install globally
|
|
71
|
+
npm install -g @tastehub/ckb
|
|
72
|
+
|
|
73
|
+
# Or run directly with npx (no install needed)
|
|
74
|
+
npx @tastehub/ckb init
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Option 2: Build from Source
|
|
78
|
+
|
|
64
79
|
```bash
|
|
65
|
-
# 1. Build
|
|
66
80
|
git clone https://github.com/SimplyLiz/CodeMCP.git
|
|
67
81
|
cd CodeMCP
|
|
68
82
|
go build -o ckb ./cmd/ckb
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Setup
|
|
69
86
|
|
|
70
|
-
|
|
87
|
+
```bash
|
|
88
|
+
# 1. Initialize in your project
|
|
71
89
|
cd /path/to/your/project
|
|
72
|
-
/
|
|
90
|
+
ckb init # or: npx @tastehub/ckb init
|
|
73
91
|
|
|
74
|
-
#
|
|
75
|
-
|
|
76
|
-
scip-go --repository-root=.
|
|
92
|
+
# 2. Generate SCIP index (optional but recommended)
|
|
93
|
+
ckb index # auto-detects language and runs appropriate indexer
|
|
77
94
|
|
|
78
|
-
#
|
|
79
|
-
|
|
95
|
+
# 3. Connect to Claude Code
|
|
96
|
+
ckb setup # creates .mcp.json automatically
|
|
97
|
+
|
|
98
|
+
# Or manually:
|
|
99
|
+
claude mcp add --transport stdio ckb -- npx @tastehub/ckb mcp
|
|
80
100
|
```
|
|
81
101
|
|
|
82
102
|
Now Claude can answer questions like:
|
|
@@ -101,9 +121,9 @@ Now Claude can answer questions like:
|
|
|
101
121
|
|
|
102
122
|
| Interface | Best For |
|
|
103
123
|
|-----------|----------|
|
|
104
|
-
| **
|
|
105
|
-
| **CLI** | Quick lookups from terminal, scripting |
|
|
106
|
-
| **HTTP API** | IDE plugins, CI integration, custom tooling |
|
|
124
|
+
| **[MCP](https://github.com/SimplyLiz/CodeMCP/wiki/MCP-Integration)** | AI-assisted development — Claude, Cursor, Windsurf, VS Code, OpenCode |
|
|
125
|
+
| **[CLI](https://github.com/SimplyLiz/CodeMCP/wiki/User-Guide)** | Quick lookups from terminal, scripting |
|
|
126
|
+
| **[HTTP API](https://github.com/SimplyLiz/CodeMCP/wiki/API-Reference)** | IDE plugins, CI integration, custom tooling |
|
|
107
127
|
|
|
108
128
|
## Features
|
|
109
129
|
|
|
@@ -144,6 +164,25 @@ Now Claude can answer questions like:
|
|
|
144
164
|
- **LLM Export** — Token-efficient codebase summaries with importance ranking
|
|
145
165
|
- **Risk Audit** — 8-factor scoring (complexity, coverage, bus factor, security, staleness, errors, coupling, churn)
|
|
146
166
|
|
|
167
|
+
### Zero-Friction UX (v7.0)
|
|
168
|
+
- **npm Distribution** — `npm install -g @tastehub/ckb` or `npx @tastehub/ckb`
|
|
169
|
+
- **Auto-Setup** — `ckb setup` configures Claude Code integration automatically
|
|
170
|
+
|
|
171
|
+
### Zero-Index Operation (v7.1)
|
|
172
|
+
- **Tree-sitter Fallback** — Symbol search works without SCIP index (8 languages)
|
|
173
|
+
- **Auto-Index** — `ckb index` detects language and runs the right SCIP indexer
|
|
174
|
+
- **Install Guidance** — Shows indexer install commands when missing
|
|
175
|
+
- **Universal MCP Docs** — Setup for Claude Code, Cursor, Windsurf, VS Code, OpenCode, Claude Desktop
|
|
176
|
+
|
|
177
|
+
### Smart Indexing & Explicit Tiers (v7.2)
|
|
178
|
+
- **Skip-if-Fresh** — `ckb index` automatically skips if index is current with HEAD
|
|
179
|
+
- **Freshness Tracking** — Tracks commits behind HEAD + uncommitted changes
|
|
180
|
+
- **Index Status** — `ckb status` shows index freshness with commit hash
|
|
181
|
+
- **Watch Mode** — `ckb mcp --watch` polls every 30s and auto-reindexes when stale
|
|
182
|
+
- **Lock File** — Prevents concurrent indexing with flock-based locking
|
|
183
|
+
- **Explicit Tiers** — Control analysis mode: `--tier=fast|standard|full` or `CKB_TIER` env var
|
|
184
|
+
- **Tier Diagnostics** — `ckb doctor --tier enhanced` shows exactly what's missing and how to fix it
|
|
185
|
+
|
|
147
186
|
## MCP Tools (58 Available)
|
|
148
187
|
|
|
149
188
|
CKB exposes code intelligence through the Model Context Protocol:
|
|
@@ -263,6 +302,9 @@ ckb decisions
|
|
|
263
302
|
# Run diagnostics
|
|
264
303
|
ckb doctor
|
|
265
304
|
|
|
305
|
+
# Check tier-specific requirements
|
|
306
|
+
ckb doctor --tier enhanced
|
|
307
|
+
|
|
266
308
|
# Start MCP server for AI assistants
|
|
267
309
|
ckb mcp
|
|
268
310
|
```
|
|
@@ -311,23 +353,25 @@ ckb serve --port 8080
|
|
|
311
353
|
# Example calls
|
|
312
354
|
curl http://localhost:8080/health
|
|
313
355
|
curl http://localhost:8080/status
|
|
314
|
-
curl http://localhost:8080/search?q=NewServer
|
|
356
|
+
curl "http://localhost:8080/search?q=NewServer"
|
|
315
357
|
curl http://localhost:8080/architecture
|
|
316
358
|
curl "http://localhost:8080/ownership?path=internal/api"
|
|
317
359
|
curl http://localhost:8080/hotspots
|
|
318
360
|
```
|
|
319
361
|
|
|
320
|
-
## MCP
|
|
362
|
+
## MCP Integration
|
|
321
363
|
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
364
|
+
CKB works with any MCP-compatible AI coding tool.
|
|
365
|
+
|
|
366
|
+
<details>
|
|
367
|
+
<summary><strong>Claude Code</strong></summary>
|
|
325
368
|
|
|
326
|
-
|
|
327
|
-
|
|
369
|
+
```bash
|
|
370
|
+
# Auto-configure for current project
|
|
371
|
+
npx @tastehub/ckb setup
|
|
328
372
|
|
|
329
|
-
#
|
|
330
|
-
|
|
373
|
+
# Or add globally for all projects
|
|
374
|
+
npx @tastehub/ckb setup --global
|
|
331
375
|
```
|
|
332
376
|
|
|
333
377
|
Or manually add to `.mcp.json`:
|
|
@@ -335,13 +379,122 @@ Or manually add to `.mcp.json`:
|
|
|
335
379
|
{
|
|
336
380
|
"mcpServers": {
|
|
337
381
|
"ckb": {
|
|
338
|
-
"command": "
|
|
339
|
-
"args": ["mcp"]
|
|
382
|
+
"command": "npx",
|
|
383
|
+
"args": ["@tastehub/ckb", "mcp"]
|
|
340
384
|
}
|
|
341
385
|
}
|
|
342
386
|
}
|
|
343
387
|
```
|
|
344
388
|
|
|
389
|
+
</details>
|
|
390
|
+
|
|
391
|
+
<details>
|
|
392
|
+
<summary><strong>Cursor</strong></summary>
|
|
393
|
+
|
|
394
|
+
Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project):
|
|
395
|
+
```json
|
|
396
|
+
{
|
|
397
|
+
"mcpServers": {
|
|
398
|
+
"ckb": {
|
|
399
|
+
"command": "npx",
|
|
400
|
+
"args": ["@tastehub/ckb", "mcp"]
|
|
401
|
+
}
|
|
402
|
+
}
|
|
403
|
+
}
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
</details>
|
|
407
|
+
|
|
408
|
+
<details>
|
|
409
|
+
<summary><strong>Windsurf</strong></summary>
|
|
410
|
+
|
|
411
|
+
Add to `~/.codeium/windsurf/mcp_config.json`:
|
|
412
|
+
```json
|
|
413
|
+
{
|
|
414
|
+
"mcpServers": {
|
|
415
|
+
"ckb": {
|
|
416
|
+
"command": "npx",
|
|
417
|
+
"args": ["@tastehub/ckb", "mcp"]
|
|
418
|
+
}
|
|
419
|
+
}
|
|
420
|
+
}
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
</details>
|
|
424
|
+
|
|
425
|
+
<details>
|
|
426
|
+
<summary><strong>VS Code</strong></summary>
|
|
427
|
+
|
|
428
|
+
Add to your VS Code `settings.json`:
|
|
429
|
+
```json
|
|
430
|
+
{
|
|
431
|
+
"mcp": {
|
|
432
|
+
"servers": {
|
|
433
|
+
"ckb": {
|
|
434
|
+
"type": "stdio",
|
|
435
|
+
"command": "npx",
|
|
436
|
+
"args": ["@tastehub/ckb", "mcp"]
|
|
437
|
+
}
|
|
438
|
+
}
|
|
439
|
+
}
|
|
440
|
+
}
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
</details>
|
|
444
|
+
|
|
445
|
+
<details>
|
|
446
|
+
<summary><strong>OpenCode</strong></summary>
|
|
447
|
+
|
|
448
|
+
Add to `opencode.json` in project root:
|
|
449
|
+
```json
|
|
450
|
+
{
|
|
451
|
+
"mcp": {
|
|
452
|
+
"ckb": {
|
|
453
|
+
"type": "local",
|
|
454
|
+
"command": ["npx", "@tastehub/ckb", "mcp"],
|
|
455
|
+
"enabled": true
|
|
456
|
+
}
|
|
457
|
+
}
|
|
458
|
+
}
|
|
459
|
+
```
|
|
460
|
+
|
|
461
|
+
</details>
|
|
462
|
+
|
|
463
|
+
<details>
|
|
464
|
+
<summary><strong>Claude Desktop</strong></summary>
|
|
465
|
+
|
|
466
|
+
Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
|
|
467
|
+
```json
|
|
468
|
+
{
|
|
469
|
+
"mcpServers": {
|
|
470
|
+
"ckb": {
|
|
471
|
+
"command": "npx",
|
|
472
|
+
"args": ["@tastehub/ckb", "mcp"],
|
|
473
|
+
"cwd": "/path/to/your/repo"
|
|
474
|
+
}
|
|
475
|
+
}
|
|
476
|
+
}
|
|
477
|
+
```
|
|
478
|
+
|
|
479
|
+
</details>
|
|
480
|
+
|
|
481
|
+
<details>
|
|
482
|
+
<summary><strong>Windows</strong></summary>
|
|
483
|
+
|
|
484
|
+
Use `cmd /c` wrapper in any config above:
|
|
485
|
+
```json
|
|
486
|
+
{
|
|
487
|
+
"mcpServers": {
|
|
488
|
+
"ckb": {
|
|
489
|
+
"command": "cmd",
|
|
490
|
+
"args": ["/c", "npx", "@tastehub/ckb", "mcp"]
|
|
491
|
+
}
|
|
492
|
+
}
|
|
493
|
+
}
|
|
494
|
+
```
|
|
495
|
+
|
|
496
|
+
</details>
|
|
497
|
+
|
|
345
498
|
## Under the Hood
|
|
346
499
|
|
|
347
500
|
CKB orchestrates multiple code intelligence backends:
|
|
@@ -372,16 +525,28 @@ See the **[Full Documentation Wiki](https://github.com/SimplyLiz/CodeMCP/wiki)**
|
|
|
372
525
|
|
|
373
526
|
- [Quick Start](https://github.com/SimplyLiz/CodeMCP/wiki/Quick-Start) — Step-by-step installation
|
|
374
527
|
- [Prompt Cookbook](https://github.com/SimplyLiz/CodeMCP/wiki/Prompt-Cookbook) — Real prompts for real problems
|
|
528
|
+
- [Language Support](https://github.com/SimplyLiz/CodeMCP/wiki/Language-Support) — SCIP indexers and support tiers
|
|
375
529
|
- [Practical Limits](https://github.com/SimplyLiz/CodeMCP/wiki/Practical-Limits) — Accuracy notes, blind spots
|
|
376
530
|
- [User Guide](https://github.com/SimplyLiz/CodeMCP/wiki/User-Guide) — CLI commands and best practices
|
|
531
|
+
- [MCP Integration](https://github.com/SimplyLiz/CodeMCP/wiki/MCP-Integration) — Claude Code setup, 58 tools
|
|
377
532
|
- [API Reference](https://github.com/SimplyLiz/CodeMCP/wiki/API-Reference) — HTTP API documentation
|
|
378
533
|
- [Configuration](https://github.com/SimplyLiz/CodeMCP/wiki/Configuration) — All options including MODULES.toml
|
|
534
|
+
- [Telemetry](https://github.com/SimplyLiz/CodeMCP/wiki/Telemetry) — Runtime observability, dead code detection
|
|
535
|
+
- [Federation](https://github.com/SimplyLiz/CodeMCP/wiki/Federation) — Cross-repository queries
|
|
536
|
+
- [CI/CD Integration](https://github.com/SimplyLiz/CodeMCP/wiki/CI-CD-Integration) — GitHub Actions, PR analysis
|
|
379
537
|
|
|
380
538
|
## Requirements
|
|
381
539
|
|
|
540
|
+
**Using npm (recommended):**
|
|
541
|
+
- Node.js 16+
|
|
542
|
+
- Git
|
|
543
|
+
|
|
544
|
+
**Building from source:**
|
|
382
545
|
- Go 1.21+
|
|
383
546
|
- Git
|
|
384
|
-
|
|
547
|
+
|
|
548
|
+
**Optional (for enhanced analysis):**
|
|
549
|
+
- SCIP indexer for your language (scip-go, scip-typescript, etc.) — run `ckb index` to auto-install
|
|
385
550
|
|
|
386
551
|
## License
|
|
387
552
|
|
package/bin/ckb
CHANGED
|
Binary file
|