@tastehub/ckb-linux-arm64 7.0.0 → 7.1.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 +169 -23
- package/bin/ckb +0 -0
- package/package.json +1 -1
package/bin/README.md
CHANGED
|
@@ -61,22 +61,39 @@ CKB provides:
|
|
|
61
61
|
|
|
62
62
|
## Quick Start
|
|
63
63
|
|
|
64
|
+
### Option 1: npm (Recommended)
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
# Install globally
|
|
68
|
+
npm install -g @tastehub/ckb
|
|
69
|
+
|
|
70
|
+
# Or run directly with npx (no install needed)
|
|
71
|
+
npx @tastehub/ckb init
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Option 2: Build from Source
|
|
75
|
+
|
|
64
76
|
```bash
|
|
65
|
-
# 1. Build
|
|
66
77
|
git clone https://github.com/SimplyLiz/CodeMCP.git
|
|
67
78
|
cd CodeMCP
|
|
68
79
|
go build -o ckb ./cmd/ckb
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Setup
|
|
69
83
|
|
|
70
|
-
|
|
84
|
+
```bash
|
|
85
|
+
# 1. Initialize in your project
|
|
71
86
|
cd /path/to/your/project
|
|
72
|
-
/
|
|
87
|
+
ckb init # or: npx @tastehub/ckb init
|
|
73
88
|
|
|
74
|
-
#
|
|
75
|
-
|
|
76
|
-
scip-go --repository-root=.
|
|
89
|
+
# 2. Generate SCIP index (optional but recommended)
|
|
90
|
+
ckb index # auto-detects language and runs appropriate indexer
|
|
77
91
|
|
|
78
|
-
#
|
|
79
|
-
|
|
92
|
+
# 3. Connect to Claude Code
|
|
93
|
+
ckb setup # creates .mcp.json automatically
|
|
94
|
+
|
|
95
|
+
# Or manually:
|
|
96
|
+
claude mcp add --transport stdio ckb -- npx @tastehub/ckb mcp
|
|
80
97
|
```
|
|
81
98
|
|
|
82
99
|
Now Claude can answer questions like:
|
|
@@ -101,9 +118,9 @@ Now Claude can answer questions like:
|
|
|
101
118
|
|
|
102
119
|
| Interface | Best For |
|
|
103
120
|
|-----------|----------|
|
|
104
|
-
| **
|
|
105
|
-
| **CLI** | Quick lookups from terminal, scripting |
|
|
106
|
-
| **HTTP API** | IDE plugins, CI integration, custom tooling |
|
|
121
|
+
| **[MCP](https://github.com/SimplyLiz/CodeMCP/wiki/MCP-Integration)** | AI-assisted development — Claude, Cursor, Windsurf, VS Code, OpenCode |
|
|
122
|
+
| **[CLI](https://github.com/SimplyLiz/CodeMCP/wiki/User-Guide)** | Quick lookups from terminal, scripting |
|
|
123
|
+
| **[HTTP API](https://github.com/SimplyLiz/CodeMCP/wiki/API-Reference)** | IDE plugins, CI integration, custom tooling |
|
|
107
124
|
|
|
108
125
|
## Features
|
|
109
126
|
|
|
@@ -144,6 +161,12 @@ Now Claude can answer questions like:
|
|
|
144
161
|
- **LLM Export** — Token-efficient codebase summaries with importance ranking
|
|
145
162
|
- **Risk Audit** — 8-factor scoring (complexity, coverage, bus factor, security, staleness, errors, coupling, churn)
|
|
146
163
|
|
|
164
|
+
### Zero-Friction UX (v7.0)
|
|
165
|
+
- **npm Distribution** — `npm install -g @tastehub/ckb` or `npx @tastehub/ckb`
|
|
166
|
+
- **Auto-Setup** — `ckb setup` configures Claude Code integration automatically
|
|
167
|
+
- **Auto-Index** — `ckb index` detects language and runs the right SCIP indexer
|
|
168
|
+
- **Analysis Tiers** — Works without SCIP index (basic mode), better with it (enhanced mode)
|
|
169
|
+
|
|
147
170
|
## MCP Tools (58 Available)
|
|
148
171
|
|
|
149
172
|
CKB exposes code intelligence through the Model Context Protocol:
|
|
@@ -311,23 +334,25 @@ ckb serve --port 8080
|
|
|
311
334
|
# Example calls
|
|
312
335
|
curl http://localhost:8080/health
|
|
313
336
|
curl http://localhost:8080/status
|
|
314
|
-
curl http://localhost:8080/search?q=NewServer
|
|
337
|
+
curl "http://localhost:8080/search?q=NewServer"
|
|
315
338
|
curl http://localhost:8080/architecture
|
|
316
339
|
curl "http://localhost:8080/ownership?path=internal/api"
|
|
317
340
|
curl http://localhost:8080/hotspots
|
|
318
341
|
```
|
|
319
342
|
|
|
320
|
-
## MCP
|
|
343
|
+
## MCP Integration
|
|
321
344
|
|
|
322
|
-
|
|
323
|
-
# Add to current project
|
|
324
|
-
claude mcp add --transport stdio ckb --scope project -- /path/to/ckb mcp
|
|
345
|
+
CKB works with any MCP-compatible AI coding tool.
|
|
325
346
|
|
|
326
|
-
|
|
327
|
-
|
|
347
|
+
<details>
|
|
348
|
+
<summary><strong>Claude Code</strong></summary>
|
|
349
|
+
|
|
350
|
+
```bash
|
|
351
|
+
# Auto-configure for current project
|
|
352
|
+
npx @tastehub/ckb setup
|
|
328
353
|
|
|
329
|
-
#
|
|
330
|
-
|
|
354
|
+
# Or add globally for all projects
|
|
355
|
+
npx @tastehub/ckb setup --global
|
|
331
356
|
```
|
|
332
357
|
|
|
333
358
|
Or manually add to `.mcp.json`:
|
|
@@ -335,13 +360,122 @@ Or manually add to `.mcp.json`:
|
|
|
335
360
|
{
|
|
336
361
|
"mcpServers": {
|
|
337
362
|
"ckb": {
|
|
338
|
-
"command": "
|
|
339
|
-
"args": ["mcp"]
|
|
363
|
+
"command": "npx",
|
|
364
|
+
"args": ["@tastehub/ckb", "mcp"]
|
|
365
|
+
}
|
|
366
|
+
}
|
|
367
|
+
}
|
|
368
|
+
```
|
|
369
|
+
|
|
370
|
+
</details>
|
|
371
|
+
|
|
372
|
+
<details>
|
|
373
|
+
<summary><strong>Cursor</strong></summary>
|
|
374
|
+
|
|
375
|
+
Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project):
|
|
376
|
+
```json
|
|
377
|
+
{
|
|
378
|
+
"mcpServers": {
|
|
379
|
+
"ckb": {
|
|
380
|
+
"command": "npx",
|
|
381
|
+
"args": ["@tastehub/ckb", "mcp"]
|
|
382
|
+
}
|
|
383
|
+
}
|
|
384
|
+
}
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
</details>
|
|
388
|
+
|
|
389
|
+
<details>
|
|
390
|
+
<summary><strong>Windsurf</strong></summary>
|
|
391
|
+
|
|
392
|
+
Add to `~/.codeium/windsurf/mcp_config.json`:
|
|
393
|
+
```json
|
|
394
|
+
{
|
|
395
|
+
"mcpServers": {
|
|
396
|
+
"ckb": {
|
|
397
|
+
"command": "npx",
|
|
398
|
+
"args": ["@tastehub/ckb", "mcp"]
|
|
340
399
|
}
|
|
341
400
|
}
|
|
342
401
|
}
|
|
343
402
|
```
|
|
344
403
|
|
|
404
|
+
</details>
|
|
405
|
+
|
|
406
|
+
<details>
|
|
407
|
+
<summary><strong>VS Code</strong></summary>
|
|
408
|
+
|
|
409
|
+
Add to your VS Code `settings.json`:
|
|
410
|
+
```json
|
|
411
|
+
{
|
|
412
|
+
"mcp": {
|
|
413
|
+
"servers": {
|
|
414
|
+
"ckb": {
|
|
415
|
+
"type": "stdio",
|
|
416
|
+
"command": "npx",
|
|
417
|
+
"args": ["@tastehub/ckb", "mcp"]
|
|
418
|
+
}
|
|
419
|
+
}
|
|
420
|
+
}
|
|
421
|
+
}
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
</details>
|
|
425
|
+
|
|
426
|
+
<details>
|
|
427
|
+
<summary><strong>OpenCode</strong></summary>
|
|
428
|
+
|
|
429
|
+
Add to `opencode.json` in project root:
|
|
430
|
+
```json
|
|
431
|
+
{
|
|
432
|
+
"mcp": {
|
|
433
|
+
"ckb": {
|
|
434
|
+
"type": "local",
|
|
435
|
+
"command": ["npx", "@tastehub/ckb", "mcp"],
|
|
436
|
+
"enabled": true
|
|
437
|
+
}
|
|
438
|
+
}
|
|
439
|
+
}
|
|
440
|
+
```
|
|
441
|
+
|
|
442
|
+
</details>
|
|
443
|
+
|
|
444
|
+
<details>
|
|
445
|
+
<summary><strong>Claude Desktop</strong></summary>
|
|
446
|
+
|
|
447
|
+
Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
|
|
448
|
+
```json
|
|
449
|
+
{
|
|
450
|
+
"mcpServers": {
|
|
451
|
+
"ckb": {
|
|
452
|
+
"command": "npx",
|
|
453
|
+
"args": ["@tastehub/ckb", "mcp"],
|
|
454
|
+
"cwd": "/path/to/your/repo"
|
|
455
|
+
}
|
|
456
|
+
}
|
|
457
|
+
}
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
</details>
|
|
461
|
+
|
|
462
|
+
<details>
|
|
463
|
+
<summary><strong>Windows</strong></summary>
|
|
464
|
+
|
|
465
|
+
Use `cmd /c` wrapper in any config above:
|
|
466
|
+
```json
|
|
467
|
+
{
|
|
468
|
+
"mcpServers": {
|
|
469
|
+
"ckb": {
|
|
470
|
+
"command": "cmd",
|
|
471
|
+
"args": ["/c", "npx", "@tastehub/ckb", "mcp"]
|
|
472
|
+
}
|
|
473
|
+
}
|
|
474
|
+
}
|
|
475
|
+
```
|
|
476
|
+
|
|
477
|
+
</details>
|
|
478
|
+
|
|
345
479
|
## Under the Hood
|
|
346
480
|
|
|
347
481
|
CKB orchestrates multiple code intelligence backends:
|
|
@@ -372,16 +506,28 @@ See the **[Full Documentation Wiki](https://github.com/SimplyLiz/CodeMCP/wiki)**
|
|
|
372
506
|
|
|
373
507
|
- [Quick Start](https://github.com/SimplyLiz/CodeMCP/wiki/Quick-Start) — Step-by-step installation
|
|
374
508
|
- [Prompt Cookbook](https://github.com/SimplyLiz/CodeMCP/wiki/Prompt-Cookbook) — Real prompts for real problems
|
|
509
|
+
- [Language Support](https://github.com/SimplyLiz/CodeMCP/wiki/Language-Support) — SCIP indexers and support tiers
|
|
375
510
|
- [Practical Limits](https://github.com/SimplyLiz/CodeMCP/wiki/Practical-Limits) — Accuracy notes, blind spots
|
|
376
511
|
- [User Guide](https://github.com/SimplyLiz/CodeMCP/wiki/User-Guide) — CLI commands and best practices
|
|
512
|
+
- [MCP Integration](https://github.com/SimplyLiz/CodeMCP/wiki/MCP-Integration) — Claude Code setup, 58 tools
|
|
377
513
|
- [API Reference](https://github.com/SimplyLiz/CodeMCP/wiki/API-Reference) — HTTP API documentation
|
|
378
514
|
- [Configuration](https://github.com/SimplyLiz/CodeMCP/wiki/Configuration) — All options including MODULES.toml
|
|
515
|
+
- [Telemetry](https://github.com/SimplyLiz/CodeMCP/wiki/Telemetry) — Runtime observability, dead code detection
|
|
516
|
+
- [Federation](https://github.com/SimplyLiz/CodeMCP/wiki/Federation) — Cross-repository queries
|
|
517
|
+
- [CI/CD Integration](https://github.com/SimplyLiz/CodeMCP/wiki/CI-CD-Integration) — GitHub Actions, PR analysis
|
|
379
518
|
|
|
380
519
|
## Requirements
|
|
381
520
|
|
|
521
|
+
**Using npm (recommended):**
|
|
522
|
+
- Node.js 16+
|
|
523
|
+
- Git
|
|
524
|
+
|
|
525
|
+
**Building from source:**
|
|
382
526
|
- Go 1.21+
|
|
383
527
|
- Git
|
|
384
|
-
|
|
528
|
+
|
|
529
|
+
**Optional (for enhanced analysis):**
|
|
530
|
+
- SCIP indexer for your language (scip-go, scip-typescript, etc.) — run `ckb index` to auto-install
|
|
385
531
|
|
|
386
532
|
## License
|
|
387
533
|
|
package/bin/ckb
CHANGED
|
Binary file
|