hoolix 0.0.1-beta.19 → 0.0.1-beta.20
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 +159 -94
- package/STABILITY.md +5 -3
- package/dist/core/version.d.ts +1 -1
- package/dist/core/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Hoolix
|
|
2
2
|
|
|
3
|
-
**Hoolix is your MCP home base.** Turn documentation sites, `llms.txt`, GitHub repositories, templates, and private knowledge sources into secure, source-grounded MCP servers your agents can trust.
|
|
3
|
+
**Hoolix is your MCP home base.** Turn documentation sites, `llms.txt`, GitHub repositories, MCP server templates, and private knowledge sources into secure, source-grounded MCP servers your agents can trust.
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/hoolix)
|
|
6
6
|
[](https://opensource.org/licenses/MIT)
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
|
|
10
10
|
> Forge docs, repos, and internal knowledge into production-grade MCP servers with a beautiful TUI, a scriptable CLI, and a lightweight GUI.
|
|
11
11
|
|
|
12
|
-
Hoolix helps developers and teams create high-quality RAG-backed MCP servers from real sources
|
|
12
|
+
Hoolix helps developers and teams create high-quality RAG-backed MCP servers from real sources, and install curated MCP server templates (filesystem, GitHub, Postgres, Brave Search, Slack, and more) in a single command. Every answer is grounded with source URLs, transports support Streamable HTTP and stdio, and you get the full daily toolkit: create, verify, start, connect, reindex, monitor, bundle, export, and share.
|
|
13
13
|
|
|
14
14
|
## Why Hoolix?
|
|
15
15
|
|
|
@@ -19,28 +19,71 @@ Agents are only as useful as the context they can reliably reach. Copy-pasted do
|
|
|
19
19
|
| --- | --- |
|
|
20
20
|
| Fast first run | `hoolix` opens the TUI; `hoolix trial` creates a demo server in one command |
|
|
21
21
|
| Trustworthy retrieval | Source-grounded search, page reads, table of contents, and `verify` health checks |
|
|
22
|
-
|
|
|
23
|
-
|
|
|
24
|
-
|
|
|
25
|
-
|
|
|
22
|
+
| Popular MCP server templates | `hoolix install filesystem`, `github-api`, `postgres`, `brave-search`, `slack`, and 9 more |
|
|
23
|
+
| Flexible source models | Single URLs, multi-source definitions, GitHub repos, private docs, and custom source plugins |
|
|
24
|
+
| Real MCP hosting | Authenticated Streamable HTTP plus stdio; proxy mode wraps any stdio server behind HTTP |
|
|
25
|
+
| Team workflows | Usage stats, audit logs, multi-server bundles, and sanitized exports |
|
|
26
|
+
| Power-user automation | `--json` across machine-friendly commands, shell completions, scheduled reindexing, and scriptable lifecycle |
|
|
26
27
|
|
|
27
28
|
## Installation
|
|
28
29
|
|
|
29
|
-
|
|
30
|
+
### Recommended: npm (provenance-verified)
|
|
30
31
|
|
|
31
|
-
|
|
32
|
+
```bash
|
|
33
|
+
npm install -g hoolix
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
This installs the published npm package with [npm provenance](https://docs.npmjs.com/generating-provenance-statements) — the cryptographic chain from source to package is public and verifiable.
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
hoolix doctor # verify the installation
|
|
40
|
+
hoolix # open the TUI
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
**Beta / pre-release:**
|
|
44
|
+
```bash
|
|
45
|
+
npm install -g hoolix@next
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Shell Completions (optional but great)
|
|
49
|
+
|
|
50
|
+
After installing, add tab-completion for your shell:
|
|
32
51
|
|
|
33
52
|
```bash
|
|
34
|
-
|
|
53
|
+
# bash — add to ~/.bashrc
|
|
54
|
+
eval "$(hoolix completion bash)"
|
|
55
|
+
|
|
56
|
+
# zsh — add to ~/.zshrc
|
|
57
|
+
eval "$(hoolix completion zsh)"
|
|
58
|
+
|
|
59
|
+
# fish — add to ~/.config/fish/config.fish
|
|
60
|
+
hoolix completion fish | source
|
|
61
|
+
|
|
62
|
+
# PowerShell — add to $PROFILE
|
|
63
|
+
hoolix completion powershell | Invoke-Expression
|
|
35
64
|
```
|
|
36
65
|
|
|
37
|
-
### Windows
|
|
66
|
+
### Standalone Binary (Linux / macOS / Windows)
|
|
38
67
|
|
|
39
|
-
|
|
40
|
-
|
|
68
|
+
Self-contained binaries require no Node.js, npm, or source files:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
# macOS / Linux
|
|
72
|
+
curl -fsSL https://raw.githubusercontent.com/JayLLM/hoolix/main/install.sh | bash
|
|
73
|
+
|
|
74
|
+
# Windows PowerShell
|
|
75
|
+
iwr -useb https://raw.githubusercontent.com/JayLLM/hoolix/main/install.ps1 | iex
|
|
41
76
|
```
|
|
42
77
|
|
|
43
|
-
|
|
78
|
+
Binaries include SHA-256 checksums for verification. Download `SHA256SUMS` from [GitHub Releases](https://github.com/JayLLM/hoolix/releases) and run:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
# Linux
|
|
82
|
+
sha256sum --check SHA256SUMS
|
|
83
|
+
|
|
84
|
+
# macOS
|
|
85
|
+
shasum -a 256 -c SHA256SUMS
|
|
86
|
+
```
|
|
44
87
|
|
|
45
88
|
### Try Without Installing
|
|
46
89
|
|
|
@@ -52,37 +95,52 @@ This is the easiest way to prove the flow on a new machine or in a demo. The ful
|
|
|
52
95
|
|
|
53
96
|
## Quick Start
|
|
54
97
|
|
|
55
|
-
### 1. Open
|
|
98
|
+
### 1. Open the TUI
|
|
56
99
|
|
|
57
100
|
```bash
|
|
58
101
|
hoolix
|
|
59
102
|
```
|
|
60
103
|
|
|
61
|
-
Running `hoolix` with no arguments opens the terminal dashboard. From there you can create servers, start or stop them, verify retrieval quality, copy client configs, launch template flows, and inspect recent logs.
|
|
104
|
+
Running `hoolix` with no arguments opens the terminal dashboard. From there you can create servers, start or stop them, verify retrieval quality, copy client configs, launch template flows, and inspect recent logs.
|
|
62
105
|
|
|
63
|
-
|
|
106
|
+
### 2. Install an MCP Server Template
|
|
64
107
|
|
|
65
|
-
|
|
108
|
+
Templates are curated, one-command installs for common tools:
|
|
66
109
|
|
|
67
110
|
```bash
|
|
68
|
-
hoolix
|
|
69
|
-
hoolix
|
|
70
|
-
hoolix
|
|
111
|
+
hoolix install filesystem /Users/you/projects --yes
|
|
112
|
+
hoolix install github-api --yes # prompts for GITHUB_TOKEN
|
|
113
|
+
hoolix install brave-search --yes # prompts for BRAVE_API_KEY
|
|
114
|
+
hoolix install postgres --credential databaseUrl=postgresql://... --yes
|
|
115
|
+
hoolix install slack --yes # prompts for bot token
|
|
116
|
+
hoolix install memory --yes
|
|
71
117
|
```
|
|
72
118
|
|
|
73
|
-
|
|
119
|
+
Browse all 14 official templates:
|
|
74
120
|
|
|
75
|
-
|
|
121
|
+
```bash
|
|
122
|
+
hoolix templates list
|
|
123
|
+
hoolix templates info brave-search
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### 3. Create a Docs RAG Server
|
|
76
127
|
|
|
77
128
|
```bash
|
|
78
|
-
hoolix
|
|
129
|
+
hoolix create "React Docs" --url https://react.dev/llms.txt --yes
|
|
130
|
+
hoolix verify react-docs
|
|
131
|
+
hoolix start react-docs
|
|
79
132
|
```
|
|
80
133
|
|
|
81
|
-
|
|
134
|
+
### 4. Connect Your MCP Client
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
hoolix connect react-docs --client cursor
|
|
138
|
+
hoolix connect my-github --client claude
|
|
139
|
+
```
|
|
82
140
|
|
|
83
|
-
|
|
141
|
+
Supported client targets include Cursor, Claude Desktop, Claude Code, VS Code, Windsurf, Continue, Cline, Grok Build, and generic JSON output. `connect` creates backups before editing client config files.
|
|
84
142
|
|
|
85
|
-
|
|
143
|
+
### 5. Ask Your Agent
|
|
86
144
|
|
|
87
145
|
```text
|
|
88
146
|
Use search_documentation to find installation instructions, then cite the source URL.
|
|
@@ -92,20 +150,23 @@ Every Hoolix search/read result includes grounding URLs so the agent can show wh
|
|
|
92
150
|
|
|
93
151
|
## Create Servers
|
|
94
152
|
|
|
95
|
-
###
|
|
153
|
+
### Template (Recommended Starting Point)
|
|
96
154
|
|
|
97
|
-
|
|
155
|
+
```bash
|
|
156
|
+
hoolix templates list
|
|
157
|
+
hoolix create "Brave Search" --template brave-search --yes
|
|
158
|
+
# or shorthand:
|
|
159
|
+
hoolix install brave-search --yes
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Single Source
|
|
98
163
|
|
|
99
164
|
```bash
|
|
100
165
|
hoolix create "React Docs" --url https://react.dev/llms.txt --yes
|
|
101
166
|
```
|
|
102
167
|
|
|
103
|
-
Use `--url` for a single documentation URL, `llms.txt`, `llms-full.txt`, GitHub URL, or regular docs page.
|
|
104
|
-
|
|
105
168
|
### Multi-Source
|
|
106
169
|
|
|
107
|
-
Use additive `--source` flags when one MCP server should combine multiple knowledge bases:
|
|
108
|
-
|
|
109
170
|
```bash
|
|
110
171
|
hoolix create "Frontend Stack" \
|
|
111
172
|
--source docs:https://react.dev/llms.txt \
|
|
@@ -113,21 +174,7 @@ hoolix create "Frontend Stack" \
|
|
|
113
174
|
--yes
|
|
114
175
|
```
|
|
115
176
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
### Template-Backed
|
|
119
|
-
|
|
120
|
-
Templates are curated starting points for common MCP servers:
|
|
121
|
-
|
|
122
|
-
```bash
|
|
123
|
-
hoolix templates list
|
|
124
|
-
hoolix templates info terraform-aws-docs
|
|
125
|
-
hoolix create "Terraform AWS" --template terraform-aws-docs --yes
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
Templates can still accept normal inputs such as `--url`, `--header`, `--cookie`, `--hybrid`, and schedules when the template supports them.
|
|
129
|
-
|
|
130
|
-
### Private Or Authenticated Sources
|
|
177
|
+
### Private or Authenticated Sources
|
|
131
178
|
|
|
132
179
|
```bash
|
|
133
180
|
hoolix create "Private Docs" \
|
|
@@ -137,19 +184,16 @@ hoolix create "Private Docs" \
|
|
|
137
184
|
--yes
|
|
138
185
|
```
|
|
139
186
|
|
|
140
|
-
For private GitHub repositories, set `GITHUB_TOKEN` before creating or reindexing.
|
|
141
|
-
|
|
142
187
|
## Core Concepts
|
|
143
188
|
|
|
144
189
|
| Concept | Meaning |
|
|
145
190
|
| --- | --- |
|
|
146
191
|
| Server | A named MCP server with its own slug, index, auth key, audit log, stats, and lifecycle |
|
|
147
|
-
| Source | A piece of knowledge to ingest
|
|
148
|
-
|
|
|
149
|
-
| Template | An official catalog entry that creates a known-good server shape |
|
|
192
|
+
| Source | A piece of knowledge to ingest: `docs:`, `github:`, `llms:`, `web:`, or `custom:` |
|
|
193
|
+
| Template | An official catalog entry — either a `docs-rag` (knowledge indexing) or `mcp-server` (config-only) server shape |
|
|
150
194
|
| Transport | How clients talk to the server: authenticated Streamable HTTP or local stdio |
|
|
151
|
-
|
|
|
152
|
-
| Bundle | A `.hoolix.json` export that can be imported elsewhere,
|
|
195
|
+
| Proxy mode | `hoolix start <slug> --proxy` wraps any stdio mcp-server behind authenticated HTTP |
|
|
196
|
+
| Bundle | A `.hoolix.json` export that can be imported elsewhere, stripped of secrets for teams |
|
|
153
197
|
|
|
154
198
|
## Common Commands
|
|
155
199
|
|
|
@@ -157,24 +201,27 @@ For private GitHub repositories, set `GITHUB_TOKEN` before creating or reindexin
|
|
|
157
201
|
| --- | --- |
|
|
158
202
|
| `hoolix` | Open the TUI dashboard |
|
|
159
203
|
| `hoolix trial` | Create a one-click demo server |
|
|
204
|
+
| `hoolix install <template>` | Install an official MCP server template in one command |
|
|
205
|
+
| `hoolix templates list` | Browse all 14 official templates |
|
|
160
206
|
| `hoolix create "Name" --url <url>` | Create from one source |
|
|
161
207
|
| `hoolix create "Name" --source docs:<url> --source github:owner/repo` | Create from multiple sources |
|
|
162
|
-
| `hoolix
|
|
163
|
-
| `hoolix templates list` | Browse official templates |
|
|
164
|
-
| `hoolix list` / `hoolix info <slug>` | Inspect registered servers |
|
|
208
|
+
| `hoolix list` | Inspect registered servers with live status |
|
|
165
209
|
| `hoolix verify <slug>` | Check source, index, grounding, and retrieval health |
|
|
166
210
|
| `hoolix start <slug>` | Start authenticated Streamable HTTP MCP hosting |
|
|
167
|
-
| `hoolix start <slug> --
|
|
211
|
+
| `hoolix start <slug> --proxy` | Proxy an mcp-server over authenticated HTTP |
|
|
168
212
|
| `hoolix connect <slug> --client cursor` | Wire the server into an MCP client |
|
|
169
|
-
| `hoolix
|
|
170
|
-
| `hoolix reindex <slug
|
|
171
|
-
| `hoolix
|
|
172
|
-
| `hoolix
|
|
173
|
-
| `hoolix
|
|
213
|
+
| `hoolix secrets set <slug> <key>` | Store or rotate a credential (masked, 0600) |
|
|
214
|
+
| `hoolix reindex <slug>` | Refresh sources and rebuild the index |
|
|
215
|
+
| `hoolix bundle export <slugs…>` | Export multiple servers into one bundle |
|
|
216
|
+
| `hoolix bundle import <file>` | Import a multi-server bundle |
|
|
217
|
+
| `hoolix completion bash\|zsh\|fish\|powershell` | Generate shell tab-completion |
|
|
218
|
+
| `hoolix stats <slug>` | Usage analytics and top queries |
|
|
219
|
+
| `hoolix audit <slug>` | Raw audit entries for security review |
|
|
174
220
|
| `hoolix export <slug> --team --strip-key` | Create a team-safe bundle |
|
|
175
221
|
| `hoolix import --file server.hoolix.json` | Import a bundle |
|
|
176
222
|
| `hoolix gui` | Open the local web dashboard |
|
|
177
|
-
| `hoolix doctor` | Diagnose install, paths, config, runtime,
|
|
223
|
+
| `hoolix doctor` | Diagnose install, paths, config, runtime, and proxy status |
|
|
224
|
+
| `hoolix update` | Self-update the binary (SHA-256 verified) |
|
|
178
225
|
|
|
179
226
|
Machine-friendly commands support `--json` so Hoolix works cleanly in scripts and CI.
|
|
180
227
|
|
|
@@ -188,7 +235,7 @@ Every hosted Hoolix server exposes:
|
|
|
188
235
|
| `read_documentation_page` | Read a grounded page or chunk by URL/title |
|
|
189
236
|
| `get_table_of_contents` | Explore indexed structure and source sections |
|
|
190
237
|
|
|
191
|
-
Tool responses include source URLs. Search tools accept token-aware options such as `maxTokens` and `contextWindowTokens
|
|
238
|
+
Tool responses include source URLs. Search tools accept token-aware options such as `maxTokens` and `contextWindowTokens`.
|
|
192
239
|
|
|
193
240
|
## Transports
|
|
194
241
|
|
|
@@ -206,17 +253,23 @@ HTTP hosting is authenticated with a per-server bearer key and includes rate lim
|
|
|
206
253
|
hoolix start react-docs --transport stdio --json
|
|
207
254
|
```
|
|
208
255
|
|
|
209
|
-
Use stdio for clients that prefer local process transports.
|
|
256
|
+
Use stdio for clients that prefer local process transports.
|
|
257
|
+
|
|
258
|
+
### Proxy Mode (mcp-server templates)
|
|
259
|
+
|
|
260
|
+
```bash
|
|
261
|
+
hoolix start my-github --proxy
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
Proxy mode wraps any stdio mcp-server behind an authenticated Hono HTTP endpoint, with auto-restart on crash (exponential backoff), 30-second health monitoring, and SSE event wrapping. The `hoolix list` column shows `proxy:PORT` for running proxy servers.
|
|
210
265
|
|
|
211
|
-
## TUI
|
|
266
|
+
## TUI and GUI
|
|
212
267
|
|
|
213
268
|
- `hoolix` launches the TUI by default.
|
|
214
269
|
- `hoolix gui` launches a token-protected local dashboard.
|
|
215
270
|
- CLI, TUI, and GUI share the same app services, definitions, catalog, verification, analytics, and server lifecycle logic.
|
|
216
271
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
## Reliability And Security
|
|
272
|
+
## Reliability and Security
|
|
220
273
|
|
|
221
274
|
- Per-server auth keys with `hoolix rotate`
|
|
222
275
|
- Tool timeouts and response guards
|
|
@@ -227,10 +280,22 @@ Use the TUI for fast daily work, the CLI for scripts and repeatability, and the
|
|
|
227
280
|
- Private source headers and cookies
|
|
228
281
|
- Team-safe exports with `--strip-key`
|
|
229
282
|
- `doctor` and `verify` health cards for fast diagnosis
|
|
283
|
+
- SHA-256 checksum verification on binary updates and installs
|
|
284
|
+
- Optional GPG `.asc` signatures on GitHub Release assets
|
|
230
285
|
|
|
231
|
-
##
|
|
286
|
+
## Multi-Server Bundles
|
|
232
287
|
|
|
233
|
-
|
|
288
|
+
Share entire setups across machines or teammates:
|
|
289
|
+
|
|
290
|
+
```bash
|
|
291
|
+
# Export multiple servers into one file (credentials are never exported)
|
|
292
|
+
hoolix bundle export my-docs my-github my-db --output team.hoolix.json
|
|
293
|
+
|
|
294
|
+
# Import on another machine (prints hoolix secrets set instructions)
|
|
295
|
+
hoolix bundle import team.hoolix.json --yes
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
## Custom Source Plugins
|
|
234
299
|
|
|
235
300
|
```bash
|
|
236
301
|
hoolix create "Internal Handbook" \
|
|
@@ -238,7 +303,7 @@ hoolix create "Internal Handbook" \
|
|
|
238
303
|
--yes
|
|
239
304
|
```
|
|
240
305
|
|
|
241
|
-
Plugins map custom source identifiers to supported source kinds
|
|
306
|
+
Plugins map custom source identifiers to supported source kinds. Place manifests in `~/.hoolix/templates/` or set `HOOLIX_SOURCE_PLUGIN_DIR`.
|
|
242
307
|
|
|
243
308
|
## Examples
|
|
244
309
|
|
|
@@ -246,11 +311,18 @@ Plugins map custom source identifiers to supported source kinds such as docs, we
|
|
|
246
311
|
# TUI-first daily workflow
|
|
247
312
|
hoolix
|
|
248
313
|
|
|
314
|
+
# Install MCP server templates
|
|
315
|
+
hoolix install filesystem /Users/you/projects --yes
|
|
316
|
+
hoolix install github-api --yes
|
|
317
|
+
hoolix install brave-search --yes
|
|
318
|
+
hoolix install postgres --credential databaseUrl=postgresql://localhost/mydb --yes
|
|
319
|
+
hoolix install memory --yes
|
|
320
|
+
|
|
249
321
|
# One-click first run
|
|
250
322
|
hoolix trial
|
|
251
323
|
hoolix connect hoolix-trial --client cursor
|
|
252
324
|
|
|
253
|
-
#
|
|
325
|
+
# Docs RAG server from llms.txt
|
|
254
326
|
hoolix create "Astro Docs" --url https://docs.astro.build/llms.txt --yes
|
|
255
327
|
hoolix verify astro-docs
|
|
256
328
|
|
|
@@ -258,33 +330,24 @@ hoolix verify astro-docs
|
|
|
258
330
|
hoolix create "Company Platform" \
|
|
259
331
|
--source docs:https://docs.example.com/llms.txt \
|
|
260
332
|
--source github:example/platform \
|
|
261
|
-
--source web:https://status.example.com/docs \
|
|
262
333
|
--yes
|
|
263
334
|
|
|
264
|
-
#
|
|
265
|
-
hoolix
|
|
335
|
+
# Proxy an mcp-server over HTTP
|
|
336
|
+
hoolix start my-github --proxy
|
|
266
337
|
|
|
267
|
-
#
|
|
268
|
-
hoolix
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
338
|
+
# Connect to clients
|
|
339
|
+
hoolix connect my-docs --client cursor
|
|
340
|
+
hoolix connect my-github --client claude-code --yes
|
|
341
|
+
|
|
342
|
+
# Multi-server bundle for teammates
|
|
343
|
+
hoolix bundle export my-docs my-github --output team.hoolix.json --team
|
|
344
|
+
hoolix bundle import team.hoolix.json --yes
|
|
272
345
|
|
|
273
346
|
# Scheduled maintenance
|
|
274
347
|
hoolix reindex company-platform --schedule daily --yes
|
|
275
348
|
hoolix reindex --due --json
|
|
276
|
-
|
|
277
|
-
# Team-safe sharing
|
|
278
|
-
hoolix export company-platform --team --strip-key --file company-platform.hoolix.json
|
|
279
|
-
hoolix import --file company-platform.hoolix.json --slug company-platform-copy --yes
|
|
280
349
|
```
|
|
281
350
|
|
|
282
|
-
## Future Vision
|
|
283
|
-
|
|
284
|
-
Hoolix is growing toward the definitive application for MCP operations: official server catalogs, richer team libraries, deeper plugin hooks, managed deployment targets, policy-aware source access, and a shared experience across CLI, TUI, GUI, and hosted workflows.
|
|
285
|
-
|
|
286
|
-
The north star is simple: when a team asks, "How do we make this knowledge available to agents safely?", the answer should be Hoolix.
|
|
287
|
-
|
|
288
351
|
## Development
|
|
289
352
|
|
|
290
353
|
```bash
|
|
@@ -322,9 +385,11 @@ See [AGENTS.md](./AGENTS.md) for architecture rules, contribution expectations,
|
|
|
322
385
|
|
|
323
386
|
Contributions are welcome. Please open an issue for substantial changes, keep PRs focused, run tests, and update documentation alongside behavior changes.
|
|
324
387
|
|
|
388
|
+
See [CONTRIBUTING.md](./CONTRIBUTING.md) and [AGENTS.md](./AGENTS.md).
|
|
389
|
+
|
|
325
390
|
## Releasing
|
|
326
391
|
|
|
327
|
-
Release automation uses `release-it` and GitHub Actions. See [docs/RELEASING.md](./docs/RELEASING.md) for the release checklist
|
|
392
|
+
Release automation uses `release-it` and GitHub Actions. See [docs/RELEASING.md](./docs/RELEASING.md) for the full release checklist, npm publish flow, binary matrix, and free signing process.
|
|
328
393
|
|
|
329
394
|
## License
|
|
330
395
|
|
|
@@ -332,6 +397,6 @@ MIT © Hoolix contributors
|
|
|
332
397
|
|
|
333
398
|
---
|
|
334
399
|
|
|
335
|
-
**Links**: [GitHub](https://github.com/JayLLM/
|
|
400
|
+
**Links**: [npm](https://www.npmjs.com/package/hoolix) · [GitHub](https://github.com/JayLLM/hoolix) · [Docs](https://jayllm.github.io/hoolix/) · [Issues](https://github.com/JayLLM/hoolix/issues) · [Releases](https://github.com/JayLLM/hoolix/releases)
|
|
336
401
|
|
|
337
402
|
Made for developers who want agents to find the right paragraph, cite the right URL, and get back to work.
|
package/STABILITY.md
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
# Hoolix Stability & Versioning Promises
|
|
2
2
|
|
|
3
|
-
**Current
|
|
3
|
+
**Current version: 0.0.1-beta.19 (pre-release)**
|
|
4
4
|
|
|
5
5
|
This document describes what is stable, what may change, and the versioning policy for Hoolix v1.0 and beyond.
|
|
6
6
|
|
|
7
|
+
> **Note:** Pre-releases (`0.0.1-beta.*`) carry **no stability guarantees**. The promises below apply once v1.0.0 ships. They are documented now so the contract is public and reviewable before that milestone.
|
|
8
|
+
|
|
7
9
|
## Installation (recommended)
|
|
8
10
|
|
|
9
11
|
```bash
|
|
@@ -32,7 +34,7 @@ Hoolix follows [Semantic Versioning](https://semver.org) `MAJOR.MINOR.PATCH`:
|
|
|
32
34
|
| New command, new template, new flag | **MINOR** |
|
|
33
35
|
| Bug fix, performance, or non-breaking behaviour | **PATCH** |
|
|
34
36
|
|
|
35
|
-
|
|
37
|
+
Once v1.0.0 ships, the promises below apply. Pre-releases carry no stability guarantees.
|
|
36
38
|
|
|
37
39
|
---
|
|
38
40
|
|
|
@@ -84,7 +86,7 @@ Official template IDs (e.g. `filesystem`, `github-api`, `postgres`) will not be
|
|
|
84
86
|
| TUI layout and key bindings | **Unstable** — may change in any MINOR |
|
|
85
87
|
| Internal `__internal-host` / `__internal-proxy` flags | **Internal** — never call directly |
|
|
86
88
|
| Web GUI (`hoolix gui`) API routes | **Unstable** until v1.1 |
|
|
87
|
-
| Community template format | Stable schema; directory path may change before v1.0 |
|
|
89
|
+
| Community template format | Stable schema; directory path may change before v1.0 GA |
|
|
88
90
|
| SSE streaming in proxy mode | Phase 1 only; full SSE streaming is planned for a future MINOR |
|
|
89
91
|
| `hoolix verify` scoring rubric | May improve; exact scores may change |
|
|
90
92
|
|
package/dist/core/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.0.1-beta.
|
|
1
|
+
export declare const VERSION = "0.0.1-beta.20";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/core/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "hoolix",
|
|
3
|
-
"version": "0.0.1-beta.
|
|
3
|
+
"version": "0.0.1-beta.20",
|
|
4
4
|
"description": "Forge documentation into powerful, secure Hoolix MCP servers. Production-grade CLI for turning docs URLs into hostable MCP servers for Grok, Claude, Cursor, and other agents.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"mcp",
|