@preapexis/pi-kit 1.0.8 → 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.
- package/README.md +26 -38
- 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
|
-
## What
|
|
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.
|
|
@@ -36,7 +35,6 @@ npm package: [@preapexis/pi-kit](https://www.npmjs.com/package/@preapexis/pi-kit
|
|
|
36
35
|
|
|
37
36
|
- **package.json** – declares this repository as a Pi package.
|
|
38
37
|
|
|
39
|
-
````md
|
|
40
38
|
## Installation
|
|
41
39
|
|
|
42
40
|
Install from npm:
|
|
@@ -44,12 +42,10 @@ Install from npm:
|
|
|
44
42
|
```bash
|
|
45
43
|
pi install npm:@preapexis/pi-kit
|
|
46
44
|
```
|
|
47
|
-
````
|
|
48
|
-
`````
|
|
49
45
|
|
|
50
46
|
After installing, restart Pi or reload extensions:
|
|
51
47
|
|
|
52
|
-
```
|
|
48
|
+
```
|
|
53
49
|
/reload
|
|
54
50
|
```
|
|
55
51
|
|
|
@@ -58,23 +54,19 @@ After installing, restart Pi or reload extensions:
|
|
|
58
54
|
Update from npm:
|
|
59
55
|
|
|
60
56
|
```bash
|
|
61
|
-
pi install npm:@preapexis/pi-kit
|
|
57
|
+
pi install npm:@preapexis/pi-kit@latest
|
|
62
58
|
```
|
|
63
59
|
|
|
64
60
|
Then reload Pi:
|
|
65
61
|
|
|
66
|
-
```
|
|
62
|
+
```
|
|
67
63
|
/reload
|
|
68
64
|
```
|
|
69
65
|
|
|
70
66
|
You can also use:
|
|
71
67
|
|
|
72
|
-
```txt
|
|
73
|
-
/update
|
|
74
|
-
```
|
|
75
|
-
|
|
76
68
|
```
|
|
77
|
-
|
|
69
|
+
/update
|
|
78
70
|
```
|
|
79
71
|
|
|
80
72
|
## Usage
|
|
@@ -83,17 +75,17 @@ You can also use:
|
|
|
83
75
|
|
|
84
76
|
Recommended flow:
|
|
85
77
|
|
|
86
|
-
```
|
|
78
|
+
```
|
|
87
79
|
/init
|
|
88
80
|
/plan <your request>
|
|
89
|
-
/save-plan
|
|
81
|
+
/save-plan
|
|
90
82
|
/implement <saved plan path or pasted plan>
|
|
91
83
|
/commit
|
|
92
84
|
```
|
|
93
85
|
|
|
94
86
|
Use review prompts when needed:
|
|
95
87
|
|
|
96
|
-
```
|
|
88
|
+
```
|
|
97
89
|
/review-safe
|
|
98
90
|
/security
|
|
99
91
|
```
|
|
@@ -102,7 +94,7 @@ Use review prompts when needed:
|
|
|
102
94
|
|
|
103
95
|
Run:
|
|
104
96
|
|
|
105
|
-
```
|
|
97
|
+
```
|
|
106
98
|
/prompts
|
|
107
99
|
```
|
|
108
100
|
|
|
@@ -112,7 +104,7 @@ This shows all available prompt workflows and how to use them.
|
|
|
112
104
|
|
|
113
105
|
Run:
|
|
114
106
|
|
|
115
|
-
```
|
|
107
|
+
```
|
|
116
108
|
/update
|
|
117
109
|
```
|
|
118
110
|
|
|
@@ -120,7 +112,7 @@ This opens an update menu for updating Pi, this kit, or project packages.
|
|
|
120
112
|
|
|
121
113
|
### Sound commands
|
|
122
114
|
|
|
123
|
-
```
|
|
115
|
+
```
|
|
124
116
|
/sound-on
|
|
125
117
|
/sound-off
|
|
126
118
|
/sound-test
|
|
@@ -150,7 +142,7 @@ The plan includes:
|
|
|
150
142
|
|
|
151
143
|
Example summary:
|
|
152
144
|
|
|
153
|
-
```
|
|
145
|
+
```
|
|
154
146
|
Use Haiku with low effort for batches 1 and 2.
|
|
155
147
|
Use Sonnet with medium effort for batches 3 and 4.
|
|
156
148
|
Use Opus with high effort for batch 5.
|
|
@@ -160,7 +152,7 @@ Use Opus with high effort for batch 5.
|
|
|
160
152
|
|
|
161
153
|
Saves a generated plan to:
|
|
162
154
|
|
|
163
|
-
```
|
|
155
|
+
```
|
|
164
156
|
docs/plans/YYYY-MM-DD-plan-name.md
|
|
165
157
|
```
|
|
166
158
|
|
|
@@ -224,13 +216,13 @@ Handles:
|
|
|
224
216
|
|
|
225
217
|
Shows compact kit status in the footer:
|
|
226
218
|
|
|
227
|
-
```
|
|
219
|
+
```
|
|
228
220
|
kit: safe · trusted · tests:none
|
|
229
221
|
```
|
|
230
222
|
|
|
231
223
|
Commands:
|
|
232
224
|
|
|
233
|
-
```
|
|
225
|
+
```
|
|
234
226
|
/test-pass
|
|
235
227
|
/test-fail
|
|
236
228
|
/test-none
|
|
@@ -242,7 +234,7 @@ Tracks session token usage and estimated cost.
|
|
|
242
234
|
|
|
243
235
|
Commands:
|
|
244
236
|
|
|
245
|
-
```
|
|
237
|
+
```
|
|
246
238
|
/usage
|
|
247
239
|
/usage-reset
|
|
248
240
|
```
|
|
@@ -251,7 +243,7 @@ Commands:
|
|
|
251
243
|
|
|
252
244
|
Adds:
|
|
253
245
|
|
|
254
|
-
```
|
|
246
|
+
```
|
|
255
247
|
/update
|
|
256
248
|
```
|
|
257
249
|
|
|
@@ -263,7 +255,7 @@ Adds optional terminal sound cues.
|
|
|
263
255
|
|
|
264
256
|
Commands:
|
|
265
257
|
|
|
266
|
-
```
|
|
258
|
+
```
|
|
267
259
|
/sound-on
|
|
268
260
|
/sound-off
|
|
269
261
|
/sound-test
|
|
@@ -273,7 +265,7 @@ Commands:
|
|
|
273
265
|
|
|
274
266
|
Adds:
|
|
275
267
|
|
|
276
|
-
```
|
|
268
|
+
```
|
|
277
269
|
/prompts
|
|
278
270
|
```
|
|
279
271
|
|
|
@@ -287,7 +279,7 @@ Adds custom PreApeXis terminal branding and visual UI customization.
|
|
|
287
279
|
|
|
288
280
|
Each skill should live in its own folder:
|
|
289
281
|
|
|
290
|
-
```
|
|
282
|
+
```
|
|
291
283
|
skills/
|
|
292
284
|
safe-coding/
|
|
293
285
|
SKILL.md
|
|
@@ -309,13 +301,13 @@ pi install -l .
|
|
|
309
301
|
|
|
310
302
|
Then reload Pi:
|
|
311
303
|
|
|
312
|
-
```
|
|
304
|
+
```
|
|
313
305
|
/reload
|
|
314
306
|
```
|
|
315
307
|
|
|
316
308
|
To add a new extension:
|
|
317
309
|
|
|
318
|
-
```
|
|
310
|
+
```
|
|
319
311
|
extensions/my-extension.ts
|
|
320
312
|
```
|
|
321
313
|
|
|
@@ -323,7 +315,7 @@ It should export a default function that receives `ExtensionAPI`.
|
|
|
323
315
|
|
|
324
316
|
To add a new prompt:
|
|
325
317
|
|
|
326
|
-
```
|
|
318
|
+
```
|
|
327
319
|
prompts/my-prompt.md
|
|
328
320
|
```
|
|
329
321
|
|
|
@@ -331,19 +323,19 @@ The filename becomes the slash command.
|
|
|
331
323
|
|
|
332
324
|
Example:
|
|
333
325
|
|
|
334
|
-
```
|
|
326
|
+
```
|
|
335
327
|
prompts/security.md → /security
|
|
336
328
|
```
|
|
337
329
|
|
|
338
330
|
To add a new skill:
|
|
339
331
|
|
|
340
|
-
```
|
|
332
|
+
```
|
|
341
333
|
skills/my-skill/SKILL.md
|
|
342
334
|
```
|
|
343
335
|
|
|
344
336
|
## Package structure
|
|
345
337
|
|
|
346
|
-
```
|
|
338
|
+
```
|
|
347
339
|
preapexis-pi-kit/
|
|
348
340
|
package.json
|
|
349
341
|
LICENSE
|
|
@@ -371,7 +363,3 @@ ISC. See the `LICENSE` file for details.
|
|
|
371
363
|
---
|
|
372
364
|
|
|
373
365
|
Built for a safer, cleaner Pi coding-agent workflow.
|
|
374
|
-
|
|
375
|
-
```
|
|
376
|
-
|
|
377
|
-
```
|