@neuledge/context 0.2.3 β 0.3.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/LICENSE +202 -0
- package/README.md +184 -146
- package/dist/build.d.ts +17 -1
- package/dist/build.js +245 -2
- package/dist/build.js.map +1 -1
- package/dist/cli.d.ts +8 -0
- package/dist/cli.js +82 -0
- package/dist/cli.js.map +1 -1
- package/dist/config.d.ts +20 -0
- package/dist/config.js +54 -0
- package/dist/config.js.map +1 -0
- package/dist/download.d.ts +20 -0
- package/dist/download.js +64 -0
- package/dist/download.js.map +1 -0
- package/dist/git.js +43 -17
- package/dist/git.js.map +1 -1
- package/dist/index.d.ts +3 -1
- package/dist/index.js +5 -1
- package/dist/index.js.map +1 -1
- package/dist/package-builder.d.ts +2 -0
- package/dist/package-builder.js +5 -2
- package/dist/package-builder.js.map +1 -1
- package/dist/server.d.ts +9 -1
- package/dist/server.js +145 -4
- package/dist/server.js.map +1 -1
- package/package.json +9 -11
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
<p align="center">
|
|
2
2
|
<h1 align="center">Context</h1>
|
|
3
3
|
<p align="center">
|
|
4
|
-
<strong>
|
|
5
|
-
Give your AI assistant expert knowledge of any libraryβoffline, instant, private.
|
|
4
|
+
<strong>Up-to-date docs for AI agents β local, instant, plug and play.</strong>
|
|
6
5
|
</p>
|
|
7
6
|
</p>
|
|
8
7
|
|
|
@@ -14,27 +13,23 @@
|
|
|
14
13
|
|
|
15
14
|
---
|
|
16
15
|
|
|
17
|
-
|
|
16
|
+
AI agents are trained on outdated docs. When libraries release new versions, your AI doesn't know β and confidently gives you wrong answers.
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
```js
|
|
19
|
+
// Your AI, mass-trained on AI SDK v5 docs, will suggest:
|
|
20
|
+
import { Experimental_Agent as Agent, stepCountIs } from 'ai';
|
|
20
21
|
|
|
21
|
-
|
|
22
|
+
// But v6 changed the API entirely:
|
|
23
|
+
import { ToolLoopAgent } from 'ai';
|
|
24
|
+
```
|
|
22
25
|
|
|
23
|
-
|
|
26
|
+
The fix isn't better prompting. It's giving your AI the right docs.
|
|
24
27
|
|
|
25
|
-
##
|
|
28
|
+
## How It Works
|
|
26
29
|
|
|
27
|
-
Context
|
|
30
|
+
Context is an MCP server backed by a [community-driven package registry](registry/) with **100+ popular libraries** already built and ready to use. When your AI agent needs documentation, it searches the registry, downloads the right package, and queries it locally β all automatically.
|
|
28
31
|
|
|
29
|
-
|
|
30
|
-
You: "How do I create middleware in Next.js 16?"
|
|
31
|
-
|
|
32
|
-
AI: [automatically queries local docs]
|
|
33
|
-
"In Next.js 16, create a middleware.ts file in your project root..."
|
|
34
|
-
[accurate, version-specific answer]
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
No copy-pasting. No hallucinations about deprecated APIs. No waiting for cloud lookups.
|
|
32
|
+
**Install once. Configure once. Then just ask your AI.**
|
|
38
33
|
|
|
39
34
|
<p align="center">
|
|
40
35
|
<img src="https://media.githubusercontent.com/media/neuledge/context/main/packages/context/assets/ai-sdk-demo.gif" alt="Context demo" width="800">
|
|
@@ -42,72 +37,6 @@ No copy-pasting. No hallucinations about deprecated APIs. No waiting for cloud l
|
|
|
42
37
|
|
|
43
38
|
---
|
|
44
39
|
|
|
45
|
-
## Real-World Use Cases
|
|
46
|
-
|
|
47
|
-
### :muscle: "Make my AI actually useful for the stack I use"
|
|
48
|
-
|
|
49
|
-
Add docs for your entire tech stack. Your AI assistant becomes an expert in the exact versions you're using:
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
context add https://github.com/vercel/next.js
|
|
53
|
-
context add https://github.com/prisma/prisma
|
|
54
|
-
context add https://github.com/tailwindlabs/tailwindcss
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
Now ask things like:
|
|
58
|
-
- *"How do I set up Prisma with Next.js App Router?"*
|
|
59
|
-
- *"What's the Tailwind config for dark mode?"*
|
|
60
|
-
- *"Show me the new Server Actions syntax"*
|
|
61
|
-
|
|
62
|
-
### :building_construction: "Stop answering the same questions for my team"
|
|
63
|
-
|
|
64
|
-
Building an internal library? Package your documentation once, share it with your team:
|
|
65
|
-
|
|
66
|
-
```bash
|
|
67
|
-
# Build docs from your repo
|
|
68
|
-
context add https://github.com/your-company/design-system
|
|
69
|
-
|
|
70
|
-
# Your whole team can now ask:
|
|
71
|
-
# "How do I use the DataTable component?"
|
|
72
|
-
# "What props does Button accept?"
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
### :airplane: "Code on flights and in coffee shops"
|
|
76
|
-
|
|
77
|
-
Context works 100% offline. Download docs once, query foreverβno internet required.
|
|
78
|
-
|
|
79
|
-
### :lock: "Keep proprietary code discussions private"
|
|
80
|
-
|
|
81
|
-
Cloud documentation services see your queries. Context runs entirely on your machine. Your questions about internal APIs stay internal.
|
|
82
|
-
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
## Why Context Over Cloud Alternatives?
|
|
86
|
-
|
|
87
|
-
| | Context7 | Deepcon | **Context** |
|
|
88
|
-
|---|:---:|:---:|:---:|
|
|
89
|
-
| **Price** | $10/month | $8/month | **Free forever** |
|
|
90
|
-
| **Free tier** | 1,000 req/month ΒΉ | 100 req/month | **Unlimited** |
|
|
91
|
-
| **Rate limits** | 60 req/hour | Throttled | **None** |
|
|
92
|
-
| **Latency** | 100-500ms | 100-300ms | **<10ms** |
|
|
93
|
-
| **Works offline** | :x: | :x: | :white_check_mark: |
|
|
94
|
-
| **Privacy** | Queries sent to cloud | Queries sent to cloud | **100% local** |
|
|
95
|
-
| **Private repos** | $15/1M tokens | :x: | **Free** |
|
|
96
|
-
|
|
97
|
-
<sub>ΒΉ Context7 reduced free tier from ~6,000 to 1,000 requests/month in January 2026</sub>
|
|
98
|
-
|
|
99
|
-
---
|
|
100
|
-
|
|
101
|
-
## :zap: Key Features
|
|
102
|
-
|
|
103
|
-
- **Single tool** - One MCP tool does everything, no multi-step lookups
|
|
104
|
-
- **Token-aware** - Smart relevance filtering, never overwhelms the context window
|
|
105
|
-
- **Dynamic schema** - Available libraries shown in tool definition
|
|
106
|
-
- **Offline-first** - Zero network calls during operation
|
|
107
|
-
- **SQLite + FTS5** - Fast full-text search with stemming
|
|
108
|
-
|
|
109
|
-
---
|
|
110
|
-
|
|
111
40
|
## :rocket: Quick Start
|
|
112
41
|
|
|
113
42
|
### 1. Install
|
|
@@ -116,28 +45,9 @@ Cloud documentation services see your queries. Context runs entirely on your mac
|
|
|
116
45
|
npm install -g @neuledge/context
|
|
117
46
|
```
|
|
118
47
|
|
|
119
|
-
### 2.
|
|
48
|
+
### 2. Connect to your AI agent
|
|
120
49
|
|
|
121
|
-
|
|
122
|
-
# From any git repository (GitHub, GitLab, Bitbucket, etc.)
|
|
123
|
-
context add https://github.com/vercel/next.js
|
|
124
|
-
context add https://gitlab.com/org/repo
|
|
125
|
-
context add git@github.com:user/repo.git
|
|
126
|
-
|
|
127
|
-
# From a local directory
|
|
128
|
-
context add ./my-project
|
|
129
|
-
context add /path/to/docs
|
|
130
|
-
|
|
131
|
-
# From URL (pre-built package)
|
|
132
|
-
context add https://example.com/react@18.db
|
|
133
|
-
|
|
134
|
-
# From local file
|
|
135
|
-
context add ./my-package.db
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
### 3. Configure your AI agent
|
|
139
|
-
|
|
140
|
-
Context works with any MCP-compatible agent. Choose your setup below:
|
|
50
|
+
Context works with any MCP-compatible agent. Pick yours:
|
|
141
51
|
|
|
142
52
|
<details>
|
|
143
53
|
<summary><strong>Claude Code</strong></summary>
|
|
@@ -274,21 +184,116 @@ extensions:
|
|
|
274
184
|
|
|
275
185
|
</details>
|
|
276
186
|
|
|
277
|
-
###
|
|
187
|
+
### 3. Ask your AI anything
|
|
278
188
|
|
|
279
|
-
That's it
|
|
189
|
+
That's it. Just ask:
|
|
280
190
|
|
|
281
191
|
> "How do I create middleware in Next.js?"
|
|
282
192
|
|
|
283
|
-
|
|
193
|
+
Your agent searches the [community registry](registry/), downloads the docs, and answers with accurate, version-specific information. Everything happens automatically β no manual `context install` needed for registry packages.
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## The Community Registry
|
|
198
|
+
|
|
199
|
+
The registry is what makes Context plug and play. It's a growing collection of **100+ pre-built documentation packages** maintained by the community. Think of it like a package manager, but for AI-ready docs.
|
|
200
|
+
|
|
201
|
+
**Popular packages available today:**
|
|
202
|
+
|
|
203
|
+
| Category | Libraries |
|
|
204
|
+
|----------|-----------|
|
|
205
|
+
| **Frameworks** | Next.js, Nuxt, Astro, SvelteKit, Remix, Hono |
|
|
206
|
+
| **React ecosystem** | React, React Router, TanStack Query, Zustand, Redux Toolkit |
|
|
207
|
+
| **Databases & ORMs** | Prisma, Drizzle, Mongoose, TypeORM |
|
|
208
|
+
| **Styling** | Tailwind CSS, shadcn/ui, Styled Components |
|
|
209
|
+
| **Testing** | Vitest, Playwright, Jest, Testing Library |
|
|
210
|
+
| **APIs & Auth** | tRPC, GraphQL, NextAuth.js, Passport |
|
|
211
|
+
| **AI & LLMs** | LangChain, AI SDK, OpenAI, Anthropic SDK |
|
|
212
|
+
|
|
213
|
+
[Browse the full registry β](registry/)
|
|
214
|
+
|
|
215
|
+
**Anyone can contribute.** If a library you use isn't listed, [submit a PR](registry/) to add it β your contribution helps every Context user.
|
|
216
|
+
|
|
217
|
+
---
|
|
218
|
+
|
|
219
|
+
## Why Local?
|
|
220
|
+
|
|
221
|
+
Context runs entirely on your machine. Docs are downloaded once and stored as compact SQLite databases in `~/.context/packages/`. After that, everything is local.
|
|
222
|
+
|
|
223
|
+
- **Fast** β Local SQLite queries return in under 10ms
|
|
224
|
+
- **Offline** β Works on flights, in coffee shops, anywhere
|
|
225
|
+
- **Private** β Your queries never leave your machine
|
|
226
|
+
- **Free** β No subscriptions, no rate limits, no usage caps
|
|
227
|
+
- **Reliable** β No outages, no API changes, no service shutdowns
|
|
228
|
+
|
|
229
|
+
---
|
|
230
|
+
|
|
231
|
+
## Beyond the Registry
|
|
232
|
+
|
|
233
|
+
The registry covers popular open-source libraries, but Context also works with any documentation source. Use `context add` to build packages from private repos, internal libraries, or anything not yet in the registry.
|
|
234
|
+
|
|
235
|
+
```bash
|
|
236
|
+
# Build from a git repository
|
|
237
|
+
context add https://github.com/your-company/design-system
|
|
238
|
+
|
|
239
|
+
# Build from a local directory
|
|
240
|
+
context add ./my-project
|
|
241
|
+
|
|
242
|
+
# Specific version tag
|
|
243
|
+
context add https://github.com/vercel/next.js/tree/v16.0.0
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
Once built, share packages with your team β they're portable `.db` files that install instantly:
|
|
247
|
+
|
|
248
|
+
```bash
|
|
249
|
+
# Export a package
|
|
250
|
+
context add ./my-project --name my-lib --pkg-version 2.0 --save ./packages/
|
|
251
|
+
|
|
252
|
+
# Teammate installs it (no build step needed)
|
|
253
|
+
context add ./packages/my-lib@2.0.db
|
|
254
|
+
```
|
|
284
255
|
|
|
285
256
|
---
|
|
286
257
|
|
|
287
258
|
## :books: CLI Reference
|
|
288
259
|
|
|
260
|
+
### `context browse <package>`
|
|
261
|
+
|
|
262
|
+
Search for packages available on the registry server.
|
|
263
|
+
|
|
264
|
+
```bash
|
|
265
|
+
# Browse by registry/name
|
|
266
|
+
context browse npm/next
|
|
267
|
+
|
|
268
|
+
# Output:
|
|
269
|
+
# npm/next@15.1.3 3.4 MB The React Framework for the Web
|
|
270
|
+
# npm/next@15.0.4 3.2 MB The React Framework for the Web
|
|
271
|
+
# ...
|
|
272
|
+
#
|
|
273
|
+
# Found 12 versions. Install with: context install npm/next
|
|
274
|
+
|
|
275
|
+
# Browse with just a name (defaults to npm)
|
|
276
|
+
context browse react
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
### `context install <registry/name> [version]`
|
|
280
|
+
|
|
281
|
+
Download and install a pre-built package from the registry server.
|
|
282
|
+
|
|
283
|
+
```bash
|
|
284
|
+
# Install latest version
|
|
285
|
+
context install npm/next
|
|
286
|
+
|
|
287
|
+
# Install a specific version
|
|
288
|
+
context install npm/next 15.0.4
|
|
289
|
+
|
|
290
|
+
# Install from other registries
|
|
291
|
+
context install pip/django
|
|
292
|
+
```
|
|
293
|
+
|
|
289
294
|
### `context add <source>`
|
|
290
295
|
|
|
291
|
-
|
|
296
|
+
Build and install a documentation package from source. Use this for libraries not in the registry, or for private/internal docs. The source type is auto-detected.
|
|
292
297
|
|
|
293
298
|
**From git repository:**
|
|
294
299
|
|
|
@@ -401,7 +406,7 @@ context remove nextjs
|
|
|
401
406
|
|
|
402
407
|
### `context serve`
|
|
403
408
|
|
|
404
|
-
Start the MCP server (used by
|
|
409
|
+
Start the MCP server (used by AI agents).
|
|
405
410
|
|
|
406
411
|
```bash
|
|
407
412
|
context serve
|
|
@@ -420,57 +425,90 @@ context query 'nextjs@16.0' 'middleware authentication'
|
|
|
420
425
|
|
|
421
426
|
---
|
|
422
427
|
|
|
423
|
-
## :gear:
|
|
428
|
+
## :gear: Architecture
|
|
424
429
|
|
|
425
430
|
```
|
|
426
|
-
|
|
427
|
-
β
|
|
428
|
-
β
|
|
429
|
-
β ββββββββββββ
|
|
430
|
-
β β
|
|
431
|
-
β β
|
|
432
|
-
β
|
|
433
|
-
β
|
|
434
|
-
β
|
|
435
|
-
β
|
|
436
|
-
β
|
|
437
|
-
β
|
|
438
|
-
|
|
439
|
-
|
|
431
|
+
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
432
|
+
β Your Machine β
|
|
433
|
+
β β
|
|
434
|
+
β ββββββββββββ ββββββββββββββββββββ ββββββββββββββ β
|
|
435
|
+
β β AI β β Context MCP β β ~/.context β β
|
|
436
|
+
β β Agent βββββΆβ Server βββββΆβ /packages β β
|
|
437
|
+
β β β β β ββββββββββββββ β
|
|
438
|
+
β ββββββββββββ ββββββββββ¬ββββββββββ β β
|
|
439
|
+
β β ββββββββββββ β
|
|
440
|
+
β β β SQLite β β
|
|
441
|
+
β β β FTS5 β β
|
|
442
|
+
β β ββββββββββββ β
|
|
443
|
+
βββββββββββββββββββββββββββββΌββββββββββββββββββββββββββββββ
|
|
444
|
+
β (first use only)
|
|
445
|
+
βΌ
|
|
446
|
+
ββββββββββββββββββ
|
|
447
|
+
β Community β
|
|
448
|
+
β Registry β
|
|
449
|
+
ββββββββββββββββββ
|
|
440
450
|
```
|
|
441
451
|
|
|
442
|
-
**
|
|
452
|
+
**First time you ask about a library:**
|
|
453
|
+
1. The MCP server searches the community registry
|
|
454
|
+
2. Downloads the pre-built documentation package (a SQLite `.db` file)
|
|
455
|
+
3. Stores it locally in `~/.context/packages/`
|
|
443
456
|
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
457
|
+
**Every time after:**
|
|
458
|
+
1. FTS5 full-text search finds relevant sections locally
|
|
459
|
+
2. Smart filtering keeps results within token budget
|
|
460
|
+
3. Your AI gets focused, accurate documentation in under 10ms
|
|
448
461
|
|
|
449
|
-
|
|
462
|
+
---
|
|
450
463
|
|
|
451
|
-
|
|
452
|
-
2. Results are filtered by relevance score
|
|
453
|
-
3. Token budget ensures responses stay concise
|
|
454
|
-
4. Claude receives focused, relevant documentation
|
|
464
|
+
## :question: FAQ
|
|
455
465
|
|
|
456
|
-
|
|
466
|
+
### Can I use Context with non-JavaScript frameworks like Spring Boot, Django, or Rails?
|
|
467
|
+
|
|
468
|
+
**Yes!** Context is language-agnostic. It natively supports Markdown (`.md`, `.mdx`), AsciiDoc (`.adoc`), and reStructuredText (`.rst`) β no conversion needed.
|
|
457
469
|
|
|
458
|
-
|
|
470
|
+
```bash
|
|
471
|
+
# Python - FastAPI (Markdown)
|
|
472
|
+
context add https://github.com/fastapi/fastapi --path docs/en/docs
|
|
473
|
+
|
|
474
|
+
# Python - Django (reStructuredText)
|
|
475
|
+
context add https://github.com/django/django --path docs
|
|
459
476
|
|
|
460
|
-
|
|
477
|
+
# Java - Spring Boot (AsciiDoc)
|
|
478
|
+
context add https://github.com/spring-projects/spring-boot --path spring-boot-project/spring-boot-docs/src/docs
|
|
461
479
|
|
|
480
|
+
# Rust - The Rust Book
|
|
481
|
+
context add https://github.com/rust-lang/book --path src
|
|
462
482
|
```
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
483
|
+
|
|
484
|
+
Point Context at the docs folder with `--path` and it handles the rest.
|
|
485
|
+
|
|
486
|
+
### Can I contribute package definitions for new ecosystems?
|
|
487
|
+
|
|
488
|
+
Yes! The `registry/` directory has YAML definitions organized by package manager:
|
|
489
|
+
|
|
490
|
+
- **`registry/npm/`** β JavaScript/TypeScript (Next.js, React, Tailwind, etc.)
|
|
491
|
+
- **`registry/pip/`** β Python (FastAPI, Flask, Django, Pydantic)
|
|
492
|
+
- **`registry/maven/`** β Java (Spring Boot, JUnit, Micrometer)
|
|
493
|
+
|
|
494
|
+
To add a package, create a YAML file:
|
|
495
|
+
|
|
496
|
+
```yaml
|
|
497
|
+
# registry/pip/my-library.yaml
|
|
498
|
+
name: my-library
|
|
499
|
+
description: "Short description of the library"
|
|
500
|
+
repository: https://github.com/org/my-library
|
|
501
|
+
|
|
502
|
+
versions:
|
|
503
|
+
- min_version: "2.0.0"
|
|
504
|
+
source:
|
|
505
|
+
type: git
|
|
506
|
+
url: https://github.com/org/my-library
|
|
507
|
+
docs_path: docs
|
|
508
|
+
tag_pattern: "v{version}"
|
|
467
509
|
```
|
|
468
510
|
|
|
469
|
-
|
|
470
|
-
- Build from any git repository (GitHub, GitLab, Bitbucket, etc.)
|
|
471
|
-
- Build from local directories
|
|
472
|
-
- Download pre-built packages from URLs
|
|
473
|
-
- Share packages via releases or any file host
|
|
511
|
+
Version discovery is supported for npm, PyPI, and Maven Central. See existing definitions for examples.
|
|
474
512
|
|
|
475
513
|
---
|
|
476
514
|
|
package/dist/build.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Build utilities for generating documentation packages.
|
|
3
|
-
* Parses markdown/MDX files and chunks them by section.
|
|
3
|
+
* Parses markdown/MDX, AsciiDoc, and reStructuredText files and chunks them by section.
|
|
4
4
|
*/
|
|
5
5
|
export interface DocFrontmatter {
|
|
6
6
|
title?: string;
|
|
@@ -23,3 +23,19 @@ export interface ParsedDoc {
|
|
|
23
23
|
* Parse a markdown/MDX file and extract sections.
|
|
24
24
|
*/
|
|
25
25
|
export declare function parseMarkdown(source: string, filePath: string): ParsedDoc;
|
|
26
|
+
/**
|
|
27
|
+
* Parse an AsciiDoc file and extract sections.
|
|
28
|
+
* Chunks on level-1 headings (== Heading), which are equivalent to markdown h2.
|
|
29
|
+
*/
|
|
30
|
+
export declare function parseAsciidoc(source: string, filePath: string): ParsedDoc;
|
|
31
|
+
/**
|
|
32
|
+
* Parse a reStructuredText file and extract sections.
|
|
33
|
+
* RST headings are text lines followed by underline characters (=, -, ~, ^, etc.).
|
|
34
|
+
* Chunks on the second heading level encountered (equivalent to markdown h2).
|
|
35
|
+
*/
|
|
36
|
+
export declare function parseRestructuredText(source: string, filePath: string): ParsedDoc;
|
|
37
|
+
/**
|
|
38
|
+
* Parse a document file, auto-detecting format from file extension.
|
|
39
|
+
* Supports: Markdown (.md, .mdx, .qmd, .rmd), AsciiDoc (.adoc), reStructuredText (.rst)
|
|
40
|
+
*/
|
|
41
|
+
export declare function parseDocument(source: string, filePath: string): ParsedDoc;
|