@llmkb/claude-code 0.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/README.md +83 -0
- package/dist/cli.js +3214 -0
- package/dist/cli.js.map +1 -0
- package/lib/color.ts +61 -0
- package/lib/config-validation.ts +332 -0
- package/lib/config.ts +61 -0
- package/lib/credentials.ts +164 -0
- package/lib/output.ts +130 -0
- package/lib/parser.ts +274 -0
- package/lib/skills.ts +554 -0
- package/lib/sync-spaces-config.ts +180 -0
- package/lib/sync-state.ts +152 -0
- package/lib/sync.ts +437 -0
- package/lib/types.ts +153 -0
- package/lib/watch-lock.ts +78 -0
- package/lib/writer.ts +409 -0
- package/package.json +55 -0
package/README.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# @llmkb/claude-code
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@llmkb/claude-code)
|
|
4
|
+
[](LICENSE)
|
|
5
|
+
|
|
6
|
+
Claude Code plugin for **llmkb** — search, read, and write your knowledge base via MCP tools directly from Claude Code.
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install -g @llmkb/claude-code
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Quick Start
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
# Initialize llmkb in your project
|
|
18
|
+
llmkb init
|
|
19
|
+
|
|
20
|
+
# Log in to your llmkb server
|
|
21
|
+
llmkb login --space my-space
|
|
22
|
+
|
|
23
|
+
# Sync local files as knowledge sources
|
|
24
|
+
llmkb sync
|
|
25
|
+
|
|
26
|
+
# Verify connection
|
|
27
|
+
llmkb doctor
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## CLI Commands
|
|
31
|
+
|
|
32
|
+
| Command | Description |
|
|
33
|
+
|---------|-------------|
|
|
34
|
+
| `llmkb init` | Scaffold `.claude-plugin/`, `.mcp.json`, and skills |
|
|
35
|
+
| `llmkb login --space <name>` | Store credentials in OS keychain |
|
|
36
|
+
| `llmkb logout` | Remove stored credentials |
|
|
37
|
+
| `llmkb sync` | Sync local files to llmkb server |
|
|
38
|
+
| `llmkb query "..."` | Query your knowledge base |
|
|
39
|
+
| `llmkb doctor` | Diagnose connection and configuration |
|
|
40
|
+
| `llmkb status` | Show current space status |
|
|
41
|
+
| `llmkb use <space>` | Switch active space |
|
|
42
|
+
| `llmkb add/remove <space>` | Manage space registrations |
|
|
43
|
+
| `llmkb spaces` | List configured spaces |
|
|
44
|
+
| `llmkb hooks` | Manage Claude Code hooks |
|
|
45
|
+
|
|
46
|
+
## MCP Configuration
|
|
47
|
+
|
|
48
|
+
The plugin registers an MCP server so Claude Code can interact with your llmkb spaces. By default it uses Docker stdio transport:
|
|
49
|
+
|
|
50
|
+
```json
|
|
51
|
+
{
|
|
52
|
+
"mcpServers": {
|
|
53
|
+
"llmkb": {
|
|
54
|
+
"command": "docker",
|
|
55
|
+
"args": ["compose", "--profile", "mvp", "exec", "-i", "api",
|
|
56
|
+
"python", "-m", "app.mcp.stdio"]
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
For production deployments, configure HTTP transport targeting your deployed llmkb server.
|
|
63
|
+
|
|
64
|
+
## Environment Variables (Headless / CI)
|
|
65
|
+
|
|
66
|
+
In environments without a keychain (Linux servers, CI), use environment variables:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
export LLMKB_ENDPOINT=https://your-server.llmkb.ai
|
|
70
|
+
export LLMKB_SPACE=my-space
|
|
71
|
+
export LLMKB_TOKEN=your-space-token
|
|
72
|
+
export LLMKB_ADMIN_TOKEN=your-admin-token
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Requirements
|
|
76
|
+
|
|
77
|
+
- **Node.js** >= 20
|
|
78
|
+
- **Docker** (for local MCP stdio transport)
|
|
79
|
+
- **llmkb server** (local Docker stack or remote deployment)
|
|
80
|
+
|
|
81
|
+
## License
|
|
82
|
+
|
|
83
|
+
MIT
|