@preapexis/pi-kit 1.0.7 → 1.0.9

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.
Files changed (2) hide show
  1. package/README.md +27 -35
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,11 +1,10 @@
1
- ````md
2
1
  # preapexis-pi-kit
3
2
 
4
3
  A personalized kit for the [Pi Agent Harness](https://github.com/earendil-works/pi) that bundles extensions, prompts, skills, and themes to improve AI-assisted coding workflows.
5
4
 
6
5
  npm package: [@preapexis/pi-kit](https://www.npmjs.com/package/@preapexis/pi-kit)
7
6
 
8
- ## Whats inside
7
+ ## What's inside
9
8
 
10
9
  - **extensions/** – TypeScript extensions that add custom behavior to Pi:
11
10
  - `safety.ts` – blocks risky shell commands, protects secrets, blocks unsafe paths, and injects safety rules.
@@ -43,11 +42,10 @@ Install from npm:
43
42
  ```bash
44
43
  pi install npm:@preapexis/pi-kit
45
44
  ```
46
- ````
47
45
 
48
46
  After installing, restart Pi or reload extensions:
49
47
 
50
- ```txt
48
+ ```
51
49
  /reload
52
50
  ```
53
51
 
@@ -56,40 +54,38 @@ After installing, restart Pi or reload extensions:
56
54
  Update from npm:
57
55
 
58
56
  ```bash
59
- pi install npm:@preapexis/pi-kit
57
+ pi install npm:@preapexis/pi-kit@latest
60
58
  ```
61
59
 
62
60
  Then reload Pi:
63
61
 
64
- ```txt
62
+ ```
65
63
  /reload
66
64
  ```
67
65
 
68
- You can also use the built-in update command:
66
+ You can also use:
69
67
 
70
- ```txt
68
+ ```
71
69
  /update
72
70
  ```
73
71
 
74
- Then select the update option you want from the menu.
75
-
76
72
  ## Usage
77
73
 
78
74
  ### Prompt workflow
79
75
 
80
76
  Recommended flow:
81
77
 
82
- ```txt
78
+ ```
83
79
  /init
84
80
  /plan <your request>
85
- /save-plan <paste generated plan>
81
+ /save-plan
86
82
  /implement <saved plan path or pasted plan>
87
83
  /commit
88
84
  ```
89
85
 
90
86
  Use review prompts when needed:
91
87
 
92
- ```txt
88
+ ```
93
89
  /review-safe
94
90
  /security
95
91
  ```
@@ -98,7 +94,7 @@ Use review prompts when needed:
98
94
 
99
95
  Run:
100
96
 
101
- ```txt
97
+ ```
102
98
  /prompts
103
99
  ```
104
100
 
@@ -108,7 +104,7 @@ This shows all available prompt workflows and how to use them.
108
104
 
109
105
  Run:
110
106
 
111
- ```txt
107
+ ```
112
108
  /update
113
109
  ```
114
110
 
@@ -116,7 +112,7 @@ This opens an update menu for updating Pi, this kit, or project packages.
116
112
 
117
113
  ### Sound commands
118
114
 
119
- ```txt
115
+ ```
120
116
  /sound-on
121
117
  /sound-off
122
118
  /sound-test
@@ -146,7 +142,7 @@ The plan includes:
146
142
 
147
143
  Example summary:
148
144
 
149
- ```txt
145
+ ```
150
146
  Use Haiku with low effort for batches 1 and 2.
151
147
  Use Sonnet with medium effort for batches 3 and 4.
152
148
  Use Opus with high effort for batch 5.
@@ -156,7 +152,7 @@ Use Opus with high effort for batch 5.
156
152
 
157
153
  Saves a generated plan to:
158
154
 
159
- ```txt
155
+ ```
160
156
  docs/plans/YYYY-MM-DD-plan-name.md
161
157
  ```
162
158
 
@@ -220,13 +216,13 @@ Handles:
220
216
 
221
217
  Shows compact kit status in the footer:
222
218
 
223
- ```txt
219
+ ```
224
220
  kit: safe · trusted · tests:none
225
221
  ```
226
222
 
227
223
  Commands:
228
224
 
229
- ```txt
225
+ ```
230
226
  /test-pass
231
227
  /test-fail
232
228
  /test-none
@@ -238,7 +234,7 @@ Tracks session token usage and estimated cost.
238
234
 
239
235
  Commands:
240
236
 
241
- ```txt
237
+ ```
242
238
  /usage
243
239
  /usage-reset
244
240
  ```
@@ -247,7 +243,7 @@ Commands:
247
243
 
248
244
  Adds:
249
245
 
250
- ```txt
246
+ ```
251
247
  /update
252
248
  ```
253
249
 
@@ -259,7 +255,7 @@ Adds optional terminal sound cues.
259
255
 
260
256
  Commands:
261
257
 
262
- ```txt
258
+ ```
263
259
  /sound-on
264
260
  /sound-off
265
261
  /sound-test
@@ -269,7 +265,7 @@ Commands:
269
265
 
270
266
  Adds:
271
267
 
272
- ```txt
268
+ ```
273
269
  /prompts
274
270
  ```
275
271
 
@@ -283,7 +279,7 @@ Adds custom PreApeXis terminal branding and visual UI customization.
283
279
 
284
280
  Each skill should live in its own folder:
285
281
 
286
- ```txt
282
+ ```
287
283
  skills/
288
284
  safe-coding/
289
285
  SKILL.md
@@ -305,13 +301,13 @@ pi install -l .
305
301
 
306
302
  Then reload Pi:
307
303
 
308
- ```txt
304
+ ```
309
305
  /reload
310
306
  ```
311
307
 
312
308
  To add a new extension:
313
309
 
314
- ```txt
310
+ ```
315
311
  extensions/my-extension.ts
316
312
  ```
317
313
 
@@ -319,7 +315,7 @@ It should export a default function that receives `ExtensionAPI`.
319
315
 
320
316
  To add a new prompt:
321
317
 
322
- ```txt
318
+ ```
323
319
  prompts/my-prompt.md
324
320
  ```
325
321
 
@@ -327,19 +323,19 @@ The filename becomes the slash command.
327
323
 
328
324
  Example:
329
325
 
330
- ```txt
326
+ ```
331
327
  prompts/security.md → /security
332
328
  ```
333
329
 
334
330
  To add a new skill:
335
331
 
336
- ```txt
332
+ ```
337
333
  skills/my-skill/SKILL.md
338
334
  ```
339
335
 
340
336
  ## Package structure
341
337
 
342
- ```txt
338
+ ```
343
339
  preapexis-pi-kit/
344
340
  package.json
345
341
  LICENSE
@@ -367,7 +363,3 @@ ISC. See the `LICENSE` file for details.
367
363
  ---
368
364
 
369
365
  Built for a safer, cleaner Pi coding-agent workflow.
370
-
371
- ```
372
-
373
- ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@preapexis/pi-kit",
3
- "version": "1.0.7",
3
+ "version": "1.0.9",
4
4
  "description": "Personal Pi coding-agent kit with safety extensions, status UI, prompt workflows, skills, and themes.",
5
5
  "keywords": [
6
6
  "pi-package",