@agimon-ai/doompi-help 0.0.1-alpha.4 → 0.0.1-alpha.6
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 +49 -12
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -1,15 +1,53 @@
|
|
|
1
1
|
# @agimon-ai/doompi-help
|
|
2
2
|
|
|
3
|
-
Activation-gated package guidance for DoomPi.
|
|
3
|
+
Activation-gated, package-owned guidance for DoomPi.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
the existing `minor_mode` client share the same activation service. Activation resolves a
|
|
7
|
-
contributor's bundled `llms.txt` first, then an immutable exact-version cache, and finally a
|
|
8
|
-
verified exact-version unpkg fallback. Deactivation removes generated Help skill wrappers
|
|
9
|
-
before the next prompt or catalog access; child sessions never load this package.
|
|
5
|
+
Part of the [DoomPi distribution](https://www.npmjs.com/package/@agimon-ai/doompi).
|
|
10
6
|
|
|
11
|
-
|
|
12
|
-
|
|
7
|
+
Help keeps extension documentation out of the default model context. Packages contribute concise `llms.txt` indexes; the Help host resolves and exposes them only while Help mode is active.
|
|
8
|
+
|
|
9
|
+
> **Alpha:** Help contribution contracts may change between releases.
|
|
10
|
+
|
|
11
|
+
## Requirements
|
|
12
|
+
|
|
13
|
+
- Node.js 22.19.0 or newer
|
|
14
|
+
- Pi 0.84.2
|
|
15
|
+
|
|
16
|
+
## Install
|
|
17
|
+
|
|
18
|
+
DoomPi includes Help as a core parent capability. To load the package directly in Pi:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
pi install npm:@agimon-ai/doompi-help
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
The Pi entrypoint is `@agimon-ai/doompi-help/extensions/doom`.
|
|
25
|
+
|
|
26
|
+
## Activate and deactivate
|
|
27
|
+
|
|
28
|
+
In an interactive DoomPi session, use `SPC h e`. Headless clients use the existing `minor_mode` protocol action.
|
|
29
|
+
|
|
30
|
+
Activation resolves each contributor in this order:
|
|
31
|
+
|
|
32
|
+
1. its published `llms.txt`;
|
|
33
|
+
2. an immutable exact-version cache;
|
|
34
|
+
3. a verified exact-version unpkg fallback.
|
|
35
|
+
|
|
36
|
+
Deactivation logically withdraws the active Help skills before the next prompt or catalog read. Cached package content or previously generated wrappers may remain on disk and must not be interpreted as still-active model context.
|
|
37
|
+
|
|
38
|
+
The package contributes `doompi-help`. Other packages, including Workflow and Config, own their own Help descriptors and indexes.
|
|
39
|
+
|
|
40
|
+
## Parent and child behavior
|
|
41
|
+
|
|
42
|
+
The DoomPi distribution assembles the Help host only in parent sessions and starts it inactive. Child sessions do not assemble the Help runtime. A custom plain-Pi host can load the extension directly, but must supply the lifecycle expected by its integration.
|
|
43
|
+
|
|
44
|
+
## Public API
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
import { activateHelpExtension, registerHelpExtension } from '@agimon-ai/doompi-help';
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
The root export is intended for hosts and tests; ordinary users activate Help through the extension and mode protocol.
|
|
13
51
|
|
|
14
52
|
## Development
|
|
15
53
|
|
|
@@ -20,9 +58,8 @@ pnpm test
|
|
|
20
58
|
pnpm lint
|
|
21
59
|
```
|
|
22
60
|
|
|
23
|
-
|
|
61
|
+
Maintained by [Agimon](https://agimon.ai/about).
|
|
24
62
|
|
|
25
|
-
##
|
|
63
|
+
## License
|
|
26
64
|
|
|
27
|
-
|
|
28
|
-
the `@agimon-ai/doompi` runtime that consumes both. Do not hand-edit generated changelogs.
|
|
65
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agimon-ai/doompi-help",
|
|
3
|
-
"version": "0.0.1-alpha.
|
|
4
|
-
"description": "Activation-gated package guidance for DoomPi",
|
|
3
|
+
"version": "0.0.1-alpha.6",
|
|
4
|
+
"description": "Activation-gated package guidance and help skills for DoomPi and Pi extensions.",
|
|
5
5
|
"keywords": [
|
|
6
|
-
"
|
|
6
|
+
"agent-documentation",
|
|
7
7
|
"coding-agent",
|
|
8
|
-
"developer-tools",
|
|
9
8
|
"doompi",
|
|
9
|
+
"help-system",
|
|
10
|
+
"pi-coding-agent",
|
|
10
11
|
"pi-extension",
|
|
11
|
-
"
|
|
12
|
-
"typescript"
|
|
12
|
+
"skills"
|
|
13
13
|
],
|
|
14
14
|
"homepage": "https://agimon.ai",
|
|
15
15
|
"license": "MIT",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"access": "public"
|
|
43
43
|
},
|
|
44
44
|
"dependencies": {
|
|
45
|
-
"@agimon-ai/doompi-extension-contracts": "0.0.1-alpha.
|
|
45
|
+
"@agimon-ai/doompi-extension-contracts": "0.0.1-alpha.23"
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
48
|
"@earendil-works/pi-coding-agent": "0.84.2",
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"tsdown": "0.22.14",
|
|
52
52
|
"typescript": "6.0.3",
|
|
53
53
|
"vitest": "4.1.10",
|
|
54
|
-
"@agimon-ai/vibe-lint-plugin-doom-extension": "0.0.1-alpha.
|
|
54
|
+
"@agimon-ai/vibe-lint-plugin-doom-extension": "0.0.1-alpha.23"
|
|
55
55
|
},
|
|
56
56
|
"peerDependencies": {
|
|
57
57
|
"@earendil-works/pi-coding-agent": "0.84.2"
|