shumengya/sproutclaw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(coding-agent): document pi-package keyword for npm discoverability

Browse Source
This commit is contained in:
Mario Zechner
2026-01-25 01:40:26 +01:00
parent 353ac792eb
commit 9dc2b9b163
2 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/coding-agent/README.md
View File

@@ -1010,6 +1010,12 @@ pi update # update all non-pinned packages
Use `-l` to install into project settings (`.pi/settings.json`). Use `-l` to install into project settings (`.pi/settings.json`).
**Discoverability:** Published pi packages should include the `pi-package` keyword in their `package.json` for npm search:
```bash
curl -s "https://registry.npmjs.org/-/v1/search?text=keywords:pi-package" | jq '.objects[].package.name'
```
**Package filtering:** By default, packages load all resources (extensions, skills, prompts, themes). To selectively load only certain resources, use the object form in settings.json: **Package filtering:** By default, packages load all resources (extensions, skills, prompts, themes). To selectively load only certain resources, use the object form in settings.json:
```json ```json

12
packages/coding-agent/docs/extensions.md
View File

@@ -242,6 +242,18 @@ To include resources from another pi package, add it as a dependency with `bundl
`bundledDependencies` embeds the package inside your tarball, preserving the `node_modules/` structure. Without it, npm's hoisting could move the dependency elsewhere, breaking the paths. `bundledDependencies` embeds the package inside your tarball, preserving the `node_modules/` structure. Without it, npm's hoisting could move the dependency elsewhere, breaking the paths.
**Discoverability:** Add the `pi-package` keyword to your `package.json` so users can find your package on npm:
```json
{
"name": "my-extension-pack",
"keywords": ["pi-package", "pi-extension", "..."],
...
}
```
Search for pi packages: `curl -s "https://registry.npmjs.org/-/v1/search?text=keywords:pi-package"`
The `package.json` approach enables: The `package.json` approach enables:
- Multiple extensions from one package - Multiple extensions from one package
- Skills, prompts, and themes declared alongside extensions - Skills, prompts, and themes declared alongside extensions