@nrl-ai/chub 0.1.3 → 0.1.5
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 +120 -0
- package/package.json +7 -7
package/README.md
ADDED
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# @nrl-ai/chub
|
|
2
|
+
|
|
3
|
+
> The missing context layer for AI-assisted development teams.
|
|
4
|
+
|
|
5
|
+
Chub is a high-performance CLI + MCP server that serves curated, versioned API documentation to AI coding agents. Built in Rust, it is a drop-in replacement for [Context Hub](https://github.com/andrewyng/context-hub) with team-first features.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install -g @nrl-ai/chub
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Quick Start
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
# Search for docs
|
|
17
|
+
chub search "stripe payments"
|
|
18
|
+
|
|
19
|
+
# Fetch a doc
|
|
20
|
+
chub get openai/chat --lang python
|
|
21
|
+
|
|
22
|
+
# List all available docs
|
|
23
|
+
chub list
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Features
|
|
27
|
+
|
|
28
|
+
- **1,553+ curated docs** — API references for popular libraries and frameworks
|
|
29
|
+
- **~44ms cold start** — native Rust binary, no Node.js runtime needed
|
|
30
|
+
- **10 MB binary** — vs ~22 MB node_modules
|
|
31
|
+
- **MCP server** — AI agents search and fetch docs automatically
|
|
32
|
+
- **Doc pinning** — lock versions so every agent uses the same reference
|
|
33
|
+
- **Team annotations** — shared knowledge committed to git
|
|
34
|
+
- **Context profiles** — role-scoped context with inheritance
|
|
35
|
+
- **Agent config sync** — generate CLAUDE.md, .cursorrules from one source
|
|
36
|
+
- **Dep auto-detection** — scan package.json, Cargo.toml, requirements.txt and more
|
|
37
|
+
|
|
38
|
+
## Usage
|
|
39
|
+
|
|
40
|
+
### Team setup
|
|
41
|
+
|
|
42
|
+
```sh
|
|
43
|
+
# Initialize project for team sharing
|
|
44
|
+
chub init
|
|
45
|
+
|
|
46
|
+
# Auto-detect dependencies and pin matching docs
|
|
47
|
+
chub init --from-deps
|
|
48
|
+
|
|
49
|
+
# Pin doc versions for the team
|
|
50
|
+
chub pin openai/chat --lang python --version 4.0
|
|
51
|
+
chub pins
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### MCP server
|
|
55
|
+
|
|
56
|
+
Start the built-in MCP server for AI agents:
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
chub mcp
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Add to your MCP config (`.mcp.json` for Claude Code, `.cursor/mcp.json` for Cursor):
|
|
63
|
+
|
|
64
|
+
```json
|
|
65
|
+
{
|
|
66
|
+
"mcpServers": {
|
|
67
|
+
"chub": {
|
|
68
|
+
"command": "chub",
|
|
69
|
+
"args": ["mcp"]
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### More commands
|
|
76
|
+
|
|
77
|
+
```sh
|
|
78
|
+
chub search "auth" --limit 5 # search with limit
|
|
79
|
+
chub get stripe/api --lang javascript # language-specific doc
|
|
80
|
+
chub profile use backend # activate context profile
|
|
81
|
+
chub annotate openai/chat "note" --team # team annotation
|
|
82
|
+
chub detect --pin # auto-pin from dependencies
|
|
83
|
+
chub agent-config generate # generate CLAUDE.md, .cursorrules
|
|
84
|
+
chub check --fix # update outdated pins
|
|
85
|
+
chub snapshot create v1.0 # snapshot current pins
|
|
86
|
+
chub update # refresh cached registry
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## How It Works
|
|
90
|
+
|
|
91
|
+
This package is a thin JavaScript wrapper that resolves the correct platform-specific binary from `optionalDependencies`. No Node.js runtime is needed at execution time — it runs the native Rust binary directly.
|
|
92
|
+
|
|
93
|
+
Supported platforms:
|
|
94
|
+
|
|
95
|
+
| Package | Platform |
|
|
96
|
+
|---|---|
|
|
97
|
+
| `@nrl-ai/chub-linux-x64` | Linux x86_64 |
|
|
98
|
+
| `@nrl-ai/chub-linux-arm64` | Linux ARM64 |
|
|
99
|
+
| `@nrl-ai/chub-darwin-x64` | macOS Intel |
|
|
100
|
+
| `@nrl-ai/chub-darwin-arm64` | macOS Apple Silicon |
|
|
101
|
+
| `@nrl-ai/chub-win32-x64` | Windows x86_64 |
|
|
102
|
+
|
|
103
|
+
## Also available via
|
|
104
|
+
|
|
105
|
+
```sh
|
|
106
|
+
pip install chub # PyPI
|
|
107
|
+
cargo install chub # crates.io
|
|
108
|
+
brew install nrl-ai/tap/chub # Homebrew
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Links
|
|
112
|
+
|
|
113
|
+
- [Documentation](https://chub.nrl.ai)
|
|
114
|
+
- [GitHub](https://github.com/nrl-ai/chub)
|
|
115
|
+
- [PyPI](https://pypi.org/project/chub/)
|
|
116
|
+
- [crates.io](https://crates.io/crates/chub)
|
|
117
|
+
|
|
118
|
+
## License
|
|
119
|
+
|
|
120
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nrl-ai/chub",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.5",
|
|
4
4
|
"description": "Chub — high-performance curated docs for AI coding agents with team sharing",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
|
-
"url": "https://github.com/
|
|
8
|
+
"url": "https://github.com/nrl-ai/chub"
|
|
9
9
|
},
|
|
10
10
|
"bin": {
|
|
11
11
|
"chub": "bin/chub.js"
|
|
12
12
|
},
|
|
13
13
|
"optionalDependencies": {
|
|
14
|
-
"@nrl-ai/chub-linux-x64": "0.1.
|
|
15
|
-
"@nrl-ai/chub-linux-arm64": "0.1.
|
|
16
|
-
"@nrl-ai/chub-darwin-x64": "0.1.
|
|
17
|
-
"@nrl-ai/chub-darwin-arm64": "0.1.
|
|
18
|
-
"@nrl-ai/chub-win32-x64": "0.1.
|
|
14
|
+
"@nrl-ai/chub-linux-x64": "0.1.5",
|
|
15
|
+
"@nrl-ai/chub-linux-arm64": "0.1.5",
|
|
16
|
+
"@nrl-ai/chub-darwin-x64": "0.1.5",
|
|
17
|
+
"@nrl-ai/chub-darwin-arm64": "0.1.5",
|
|
18
|
+
"@nrl-ai/chub-win32-x64": "0.1.5"
|
|
19
19
|
},
|
|
20
20
|
"engines": {
|
|
21
21
|
"node": ">=16"
|