@kibhq/cli 0.1.0 → 0.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/README.md +103 -0
- package/package.json +7 -2
package/README.md
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# kib
|
|
2
|
+
|
|
3
|
+
The Headless Knowledge Compiler. A CLI-first, LLM-powered tool that turns raw source material into a structured, queryable markdown wiki — maintained entirely by AI.
|
|
4
|
+
|
|
5
|
+
`git` for knowledge — ingest, compile, query, lint, all from the terminal.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# npm / bun
|
|
11
|
+
npm i -g @kibhq/cli
|
|
12
|
+
|
|
13
|
+
# or run without installing
|
|
14
|
+
npx @kibhq/cli init
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Standalone binaries for macOS and Linux are available on the [releases page](https://github.com/keeganthomp/kib/releases).
|
|
18
|
+
|
|
19
|
+
## Quick Start
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
# Initialize a vault
|
|
23
|
+
kib init
|
|
24
|
+
|
|
25
|
+
# Ingest sources (URLs, files, PDFs, YouTube, GitHub repos)
|
|
26
|
+
kib ingest https://arxiv.org/abs/1706.03762
|
|
27
|
+
kib ingest ./papers/*.pdf
|
|
28
|
+
kib ingest https://www.youtube.com/watch?v=...
|
|
29
|
+
|
|
30
|
+
# Compile into wiki articles
|
|
31
|
+
kib compile
|
|
32
|
+
|
|
33
|
+
# Search your knowledge base
|
|
34
|
+
kib search "attention mechanisms"
|
|
35
|
+
|
|
36
|
+
# Ask questions (RAG over your wiki)
|
|
37
|
+
kib query "what are the tradeoffs between MoE and dense models?"
|
|
38
|
+
|
|
39
|
+
# Interactive chat
|
|
40
|
+
kib chat
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Commands
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
CORE
|
|
47
|
+
init Create a new vault in the current directory
|
|
48
|
+
ingest <source> Ingest sources into raw/ (URLs, files, PDFs, etc.)
|
|
49
|
+
compile Compile raw sources into wiki articles via LLM
|
|
50
|
+
query <question> Ask a question against the knowledge base (RAG)
|
|
51
|
+
search <term> Fast BM25 text search across the vault
|
|
52
|
+
chat Interactive REPL with conversation history
|
|
53
|
+
lint Run health checks on the wiki
|
|
54
|
+
status Vault health dashboard
|
|
55
|
+
|
|
56
|
+
MANAGEMENT
|
|
57
|
+
config [key] [val] Get or set configuration
|
|
58
|
+
skill <sub> [name] Manage skills (list, run)
|
|
59
|
+
watch Watch inbox/ and auto-ingest new files
|
|
60
|
+
export Export wiki to markdown or HTML
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## LLM Providers
|
|
64
|
+
|
|
65
|
+
On first use, kib walks you through provider setup interactively. Or set via environment:
|
|
66
|
+
|
|
67
|
+
| Provider | Env Variable | Default Model |
|
|
68
|
+
|----------|-------------|---------------|
|
|
69
|
+
| Anthropic | `ANTHROPIC_API_KEY` | claude-sonnet-4-20250514 |
|
|
70
|
+
| OpenAI | `OPENAI_API_KEY` | gpt-4o |
|
|
71
|
+
| Ollama | (auto-detect localhost:11434) | llama3 |
|
|
72
|
+
|
|
73
|
+
## Vault Structure
|
|
74
|
+
|
|
75
|
+
```
|
|
76
|
+
my-vault/
|
|
77
|
+
├── .kb/ # Config, manifest, cache
|
|
78
|
+
├── raw/ # Ingested source material (never modified by compile)
|
|
79
|
+
│ ├── articles/
|
|
80
|
+
│ ├── papers/
|
|
81
|
+
│ ├── transcripts/
|
|
82
|
+
│ └── repos/
|
|
83
|
+
├── wiki/ # LLM-compiled knowledge base
|
|
84
|
+
│ ├── INDEX.md # Master index
|
|
85
|
+
│ ├── GRAPH.md # Article relationship graph
|
|
86
|
+
│ ├── concepts/
|
|
87
|
+
│ ├── topics/
|
|
88
|
+
│ ├── references/
|
|
89
|
+
│ └── outputs/
|
|
90
|
+
└── inbox/ # Drop zone for kib watch
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The vault is just files. View it in any editor. Version it with git. No lock-in.
|
|
94
|
+
|
|
95
|
+
## Links
|
|
96
|
+
|
|
97
|
+
- [GitHub](https://github.com/keeganthomp/kib)
|
|
98
|
+
- [Roadmap](https://github.com/keeganthomp/kib/blob/main/ROADMAP.md)
|
|
99
|
+
- [@kibhq/core](https://www.npmjs.com/package/@kibhq/core) — core engine (for programmatic use)
|
|
100
|
+
|
|
101
|
+
## License
|
|
102
|
+
|
|
103
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kibhq/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "The Headless Knowledge Compiler — turn raw sources into a structured, queryable wiki with AI",
|
|
4
5
|
"type": "module",
|
|
5
6
|
"bin": {
|
|
6
7
|
"kib": "./bin/kib.ts"
|
|
@@ -8,6 +9,7 @@
|
|
|
8
9
|
"files": [
|
|
9
10
|
"bin",
|
|
10
11
|
"src",
|
|
12
|
+
"README.md",
|
|
11
13
|
"package.json"
|
|
12
14
|
],
|
|
13
15
|
"repository": {
|
|
@@ -16,6 +18,9 @@
|
|
|
16
18
|
"directory": "packages/cli"
|
|
17
19
|
},
|
|
18
20
|
"license": "MIT",
|
|
21
|
+
"publishConfig": {
|
|
22
|
+
"access": "public"
|
|
23
|
+
},
|
|
19
24
|
"keywords": [
|
|
20
25
|
"knowledge-base",
|
|
21
26
|
"wiki",
|
|
@@ -30,7 +35,7 @@
|
|
|
30
35
|
"test": "bun test"
|
|
31
36
|
},
|
|
32
37
|
"dependencies": {
|
|
33
|
-
"@kibhq/core": "
|
|
38
|
+
"@kibhq/core": "^0.1.0",
|
|
34
39
|
"commander": "^14.0.0",
|
|
35
40
|
"chalk": "^5.4.1",
|
|
36
41
|
"ora": "^8.2.0"
|