pi-skill-shiori 0.3.0 → 0.3.2

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/CHANGELOG.md ADDED
@@ -0,0 +1,67 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ This project follows semantic versioning.
6
+
7
+ ## [0.3.2] - 2026-06-24
8
+
9
+ ### Added
10
+
11
+ - `ROADMAP.md` with maintenance-first phased goals (Month 1–3), template compliance checklist, and maintenance schedule.
12
+ - README links to `ROADMAP.md`.
13
+ - npm package `files` now includes `ROADMAP.md`.
14
+
15
+ ## [0.3.1] - 2026-06-19
16
+
17
+ ### Added
18
+
19
+ - `SECURITY.md` with vulnerability reporting guidance and Pi package security notes.
20
+ - `CHANGELOG.md` for version history.
21
+
22
+ ### Changed
23
+
24
+ - README links to `SECURITY.md` and `CHANGELOG.md`.
25
+ - npm package files now include `SECURITY.md` and `CHANGELOG.md`.
26
+
27
+ ## [0.3.0] - 2026-06-08
28
+
29
+ ### Changed
30
+
31
+ - Shiori slash commands use UI flows for doctor, bootstrap, reload, recommend, and stats.
32
+
33
+ ## [0.2.1] - 2026-06-02
34
+
35
+ ### Changed
36
+
37
+ - Patch release after the recommendation flow updates in `0.2.0`.
38
+
39
+ ## [0.2.0] - 2026-06-02
40
+
41
+ ### Added
42
+
43
+ - Recommendation-first `/shiori:recommend` flow with query expansion and agent task queuing.
44
+ - Pre-loading of multiple recommended skills in one agent turn.
45
+ - Planning-intent handling that returns a dev-plan intake template without dumping skill bodies.
46
+
47
+ ### Fixed
48
+
49
+ - Skill retrieval for block descriptions and Japanese queries.
50
+
51
+ ### Changed
52
+
53
+ - README install snippets aligned with the published package version.
54
+
55
+ ## [0.1.1] - 2026-05-26
56
+
57
+ ### Added
58
+
59
+ - npm publish workflow and auto-release on merge to `main`.
60
+ - npm publish commands and unpinned install examples in README.
61
+
62
+ ## [0.1.0] - 2026-05-24
63
+
64
+ ### Added
65
+
66
+ - Initial Pi Skill Shiori release.
67
+ - Zero-Catalog mode, policy-based retrieval, SQLite FTS indexing, and on-demand `shiori_load_skill` tool.
package/README.md CHANGED
@@ -4,6 +4,8 @@ Pi Skill Shiori is a [Pi](https://pi.dev/) package that keeps large Agent Skill
4
4
 
5
5
  It is built for vaults or projects with many Agent Skills where the default catalog becomes noisy and expensive.
6
6
 
7
+ For maintenance priorities and the phased plan, see [`ROADMAP.md`](ROADMAP.md).
8
+
7
9
  ## What it does
8
10
 
9
11
  - **Zero-Catalog Mode**: hides the normal skill catalog when Pi exposes one in the system prompt.
@@ -15,7 +17,7 @@ It is built for vaults or projects with many Agent Skills where the default cata
15
17
 
16
18
  ## Status
17
19
 
18
- `0.3.0` is an early working release. It is useful for local Pi workflows, but the prompt-boundary suppression logic is intentionally conservative: if Shiori cannot safely recognize a catalog boundary, it leaves the prompt untouched and warns instead of deleting too much.
20
+ `0.3.1` is an early working release. It is useful for local Pi workflows, but the prompt-boundary suppression logic is intentionally conservative: if Shiori cannot safely recognize a catalog boundary, it leaves the prompt untouched and warns instead of deleting too much.
19
21
 
20
22
  ## Requirements
21
23
 
@@ -37,7 +39,7 @@ Pi core packages are peer dependencies and should be supplied by the Pi runtime:
37
39
  After the package is published to npm:
38
40
 
39
41
  ```bash
40
- pi install npm:pi-skill-shiori@0.3.0
42
+ pi install npm:pi-skill-shiori@0.3.1
41
43
  ```
42
44
 
43
45
  Without a version pin:
@@ -51,7 +53,7 @@ pi install npm:pi-skill-shiori
51
53
  Use `-l` to write the package to the current project’s `.pi/settings.json`:
52
54
 
53
55
  ```bash
54
- pi install -l npm:pi-skill-shiori@0.3.0
56
+ pi install -l npm:pi-skill-shiori@0.3.1
55
57
  ```
56
58
 
57
59
  Without a version pin:
@@ -65,7 +67,7 @@ Equivalent pinned manual `.pi/settings.json` entry:
65
67
  ```json
66
68
  {
67
69
  "packages": [
68
- "npm:pi-skill-shiori@0.3.0"
70
+ "npm:pi-skill-shiori@0.3.1"
69
71
  ]
70
72
  }
71
73
  ```
@@ -83,7 +85,7 @@ Equivalent unpinned manual `.pi/settings.json` entry:
83
85
  ### Global install from GitHub
84
86
 
85
87
  ```bash
86
- pi install git:github.com/eiei114/pi-skill-shiori@v0.3.0
88
+ pi install git:github.com/eiei114/pi-skill-shiori@v0.3.1
87
89
  ```
88
90
 
89
91
  Without a tag pin:
@@ -95,7 +97,7 @@ pi install git:github.com/eiei114/pi-skill-shiori
95
97
  ### Project-local install from GitHub
96
98
 
97
99
  ```bash
98
- pi install -l git:github.com/eiei114/pi-skill-shiori@v0.3.0
100
+ pi install -l git:github.com/eiei114/pi-skill-shiori@v0.3.1
99
101
  ```
100
102
 
101
103
  Without a tag pin:
@@ -267,6 +269,8 @@ npm whoami
267
269
  npm run release:npm
268
270
  ```
269
271
 
272
+ For version history, see [`CHANGELOG.md`](CHANGELOG.md).
273
+
270
274
  For a first-time publish, login first:
271
275
 
272
276
  ```bash
@@ -276,7 +280,7 @@ npm login
276
280
  After publishing, verify the Pi install path:
277
281
 
278
282
  ```bash
279
- pi install npm:pi-skill-shiori@0.3.0
283
+ pi install npm:pi-skill-shiori@0.3.1
280
284
  pi install npm:pi-skill-shiori
281
285
  pi list
282
286
  /shiori:doctor
@@ -290,12 +294,14 @@ git push --follow-tags
290
294
  npm run release:npm
291
295
  ```
292
296
 
293
- ## Security notes
297
+ ## Security
294
298
 
295
299
  Pi packages execute local code with the same permissions as Pi. Review third-party packages before installing them.
296
300
 
297
301
  Shiori itself does not sandbox skills. It only changes how skill candidates are discovered and loaded. A loaded skill can still instruct the model to run tools, edit files, or execute commands according to your Pi/tool permissions.
298
302
 
303
+ For vulnerability reporting, see [`SECURITY.md`](SECURITY.md).
304
+
299
305
  ## License
300
306
 
301
307
  MIT
package/ROADMAP.md ADDED
@@ -0,0 +1,132 @@
1
+ # Roadmap
2
+
3
+ Pi Skill Shiori keeps large Agent Skill catalogs out of the model prompt and lets
4
+ the agent load only the skills that match the current task. This roadmap states
5
+ **what we prioritize next** and how the package is maintained.
6
+
7
+ ## Direction
8
+
9
+ `0.3.x` is a working release. The near-term priority is **stabilization and
10
+ public quality over new feature surface**. Before widening functionality, we
11
+ harden what already ships:
12
+
13
+ - **Stabilize existing behavior** — make catalog suppression and retrieval reliable.
14
+ - **Speed and token efficiency** — startup cost, index rebuild, and candidate injection footprint.
15
+ - **Explicit design boundaries** — name the contracts (policy file, hook activation, suppression).
16
+ - **Template compliance** — close gaps against the shared Pi extension OSS policy.
17
+ - **Publish quality** — README, CHANGELOG, SECURITY, CI, `npm pack`, and release handoff.
18
+
19
+ Constraints:
20
+
21
+ - Existing commands, tools, and the main UX stay unless a compatibility fix is required.
22
+ - `shiori:*` commands stay argument-less; detail is collected after launch via Pi UI.
23
+ - npm publish stays Trusted Publishing / OIDC. Secrets and production actions remain human-owned.
24
+
25
+ ## Skill features vs. template requirements
26
+
27
+ Two kinds of work are tracked separately so feature work is not confused with
28
+ packaging/hygiene work:
29
+
30
+ - **Skill features** — Zero-Catalog suppression, policy-based retrieval, candidate
31
+ injection, on-demand loading, hybrid retrieval. These change what the package does.
32
+ - **Template requirements** — README badges, CI gates, `npm pack` cleanliness, action
33
+ pinning, version-bump checks. These keep the package publishable and aligned with
34
+ `pi-extension-template`.
35
+
36
+ Template gaps are addressed first because they protect every later release.
37
+
38
+ ## Maintenance schedule
39
+
40
+ - **Patch release** — as needed for fixes, doc/template compliance, and small behavior changes.
41
+ - **Minor release** — retrieval quality or candidate-flow improvements.
42
+ - **Release cadence** — ship per ready slice; no fixed calendar release. Every mergeable
43
+ change bumps `package.json` and `CHANGELOG.md` so npm can publish.
44
+ - **Dependency review** — monthly; bump `devDependencies`/Pi peers without behavior change.
45
+ - **Release flow** — `npm version <patch|minor>` → push → `auto-release.yml` tags and
46
+ releases → `publish.yml` publishes via Trusted Publishing (provenance verified).
47
+
48
+ `/shiori:stats` reports operational counters (token saved, candidate hits, loads,
49
+ zero-candidate turns, explicit invocations) that feed back into this schedule.
50
+
51
+ ## Phased goals (Month 1–3)
52
+
53
+ Each item is a small, independently verifiable slice (roughly 30–90 minutes) with a
54
+ semver classification. Patches default to `patch`; `none` means no package publish.
55
+
56
+ ### Month 1 — Public quality and template compliance
57
+
58
+ | # | Slice | Bump | Status |
59
+ |---|---|---|---|
60
+ | 1 | Add README status badges (CI, Publish, npm version, npm downloads, License, Pi package, Trusted Publishing) | patch | planned |
61
+ | 2 | Add `version:check` CI gate (block publishable-path changes without a semver increase) | none | planned |
62
+ | 3 | Pin GitHub Actions to commit SHAs in `ci.yml`, `auto-release.yml`, `publish.yml` | none | planned |
63
+
64
+ ### Month 2 — Stabilization and design boundaries
65
+
66
+ | # | Slice | Bump | Status |
67
+ |---|---|---|---|
68
+ | 4 | Harden catalog boundary detection and add boundary tests (reduce `failed-pattern-not-found`) | patch | planned |
69
+ | 5 | Integration test for Dual Hook Activation (input-hook explicit pass-through + `before_agent_start` candidate injection) | none | planned |
70
+
71
+ ### Month 3 — Speed and token efficiency
72
+
73
+ | # | Slice | Bump | Status |
74
+ |---|---|---|---|
75
+ | 6 | Add startup/operation timing instrumentation to `/shiori:stats` (Full Index Rebuild + retrieval baseline) | patch | planned |
76
+ | 7 | Startup index strategy (incremental / lazy / cached) — needs a design decision before implementation | none | blocked (design) |
77
+
78
+ ## Integration testing for skill hooks
79
+
80
+ Dual Hook Activation is the core discovery path and must be covered end to end:
81
+
82
+ - **Input hook** — explicit invocation pass-through: `/skill:name` and explicit names load
83
+ regardless of activation policy, including under Zero-Catalog Mode.
84
+ - **`before_agent_start` hook** — automatic candidate injection for triggerable skills only,
85
+ bounded by `maxCandidates` and `minScore`, with explicit skills excluded.
86
+
87
+ The Month 2 integration test asserts both paths together (explicit load still works while
88
+ triggerable candidates are injected) so a regression in one hook surfaces immediately.
89
+
90
+ ## Template compliance checklist
91
+
92
+ Current status against the shared Pi extension OSS policy. Gaps become Month 1 work.
93
+
94
+ - [x] `README.md`, `LICENSE`, `SECURITY.md`, `CHANGELOG.md` at repo root
95
+ - [x] CI runs `npm run typecheck`, `npm test`, and `npm pack --dry-run`
96
+ - [x] npm Trusted Publishing (`publish.yml` uses `id-token: write`, no `NPM_TOKEN`)
97
+ - [x] `auto-release.yml` → `publish.yml` release handoff
98
+ - [x] `package.json` `files` is explicit (no `node_modules`, tests, or local state)
99
+ - [x] No template `example-skill` / `example` / `example-theme` resources shipped
100
+ - [ ] **README status badges** (CI, Publish, npm version, npm downloads, License, Pi package, Trusted Publishing) — *Month 1 #1*
101
+ - [ ] **`version:check` CI gate** so publishable-path changes cannot merge without a bump — *Month 1 #2*
102
+ - [ ] **Pin GitHub Actions to commit SHAs** (currently floating `@v4`) — *Month 1 #3*
103
+
104
+ ## Current backlog integration
105
+
106
+ Feature-track items already shipped (kept here so the roadmap reflects reality, not a
107
+ fresh to-do list):
108
+
109
+ - Recommendation-first `/shiori:recommend` flow with query expansion and planning intent — shipped (`0.2.0`)
110
+ - CI + auto-release + publish handoff — shipped (`0.1.1`+)
111
+ - `shiori:*` commands use Pi UI flows (argument-less) — shipped (`0.3.0`)
112
+ - `SECURITY.md` and `CHANGELOG.md` — shipped (`0.3.1`)
113
+
114
+ Remaining feature-track item, deferred behind the maintenance-first direction:
115
+
116
+ - README/docs alignment with the minimal public-docs policy — open; the Month 1 badge
117
+ and CI slices advance this track without blocking on the broader docs-policy decision.
118
+
119
+ ## Later (feature track)
120
+
121
+ - Retrieval quality improvements (embedding candidate added beside SQLite FTS).
122
+ - Cross-vault skill index.
123
+ - ResourceLoader-side catalog replacement (stable-stage Two-stage Catalog Suppression).
124
+
125
+ These are intentionally **after** the Month 1–3 maintenance work.
126
+
127
+ ## Non-goals
128
+
129
+ - Rewriting existing commands, tools, or the candidate/recommend UX.
130
+ - Auto-approving npm publish, permission changes, or production actions.
131
+ - Removing the conservative catalog-suppression safety boundary (`not-needed` /
132
+ `failed-pattern-not-found` stay safe-by-default).
package/SECURITY.md ADDED
@@ -0,0 +1,22 @@
1
+ # Security Policy
2
+
3
+ ## Supported versions
4
+
5
+ Only the latest published version receives security fixes.
6
+
7
+ ## Reporting a vulnerability
8
+
9
+ Open a private security advisory on GitHub, or contact the maintainer by the preferred channel listed in the repository profile.
10
+
11
+ Please include:
12
+
13
+ - Affected version
14
+ - Impact
15
+ - Reproduction steps
16
+ - Suggested fix, if known
17
+
18
+ ## Pi package security note
19
+
20
+ Pi packages can execute code with local user permissions. Review installed packages and avoid running untrusted extensions.
21
+
22
+ Pi Skill Shiori does not sandbox skills. It changes how skill candidates are discovered and loaded. A loaded skill can still instruct the model to run tools, edit files, or execute commands according to your Pi and tool permissions.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pi-skill-shiori",
3
- "version": "0.3.0",
3
+ "version": "0.3.2",
4
4
  "description": "Pi extension that reduces Agent Skill catalog tokens with policy-based skill retrieval and on-demand skill loading.",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -23,7 +23,10 @@
23
23
  },
24
24
  "files": [
25
25
  "README.md",
26
+ "ROADMAP.md",
26
27
  "LICENSE",
28
+ "SECURITY.md",
29
+ "CHANGELOG.md",
27
30
  "src"
28
31
  ],
29
32
  "scripts": {