@selesai/code 0.9.5 → 0.9.8

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 (284) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/dist/cli/credential-print.js +4 -4
  3. package/dist/cli.js +0 -0
  4. package/dist/core/agent-session-runtime.js +1 -4
  5. package/dist/core/agent-session.d.ts +2 -0
  6. package/dist/core/agent-session.js +26 -0
  7. package/dist/core/compaction/branch-summarization.js +30 -30
  8. package/dist/core/compaction/compaction.js +81 -81
  9. package/dist/core/compaction/utils.js +2 -2
  10. package/dist/core/export-html/template.css +1066 -1066
  11. package/dist/core/export-html/template.html +55 -55
  12. package/dist/core/export-html/template.js +1864 -1864
  13. package/dist/core/export-html/vendor/highlight.min.js +1212 -1212
  14. package/dist/core/export-html/vendor/marked.min.js +78 -78
  15. package/dist/core/handoff.d.ts +11 -0
  16. package/dist/core/handoff.js +49 -0
  17. package/dist/core/messages.js +7 -7
  18. package/dist/extensions/context-compaction-reminder.test.ts +82 -82
  19. package/dist/extensions/context-compaction-reminder.ts +28 -28
  20. package/dist/extensions/handoff-new.ts +14 -75
  21. package/dist/extensions/pi-intercom/LICENSE +21 -21
  22. package/dist/extensions/pi-intercom/broker/client.test.ts +83 -83
  23. package/dist/extensions/pi-intercom/broker/extension.test.ts +387 -387
  24. package/dist/extensions/pi-intercom/broker/framing.test.ts +114 -114
  25. package/dist/extensions/pi-intercom/broker/paths.test.ts +153 -153
  26. package/dist/extensions/pi-intercom/broker/paths.ts +134 -134
  27. package/dist/extensions/pi-intercom/broker/runtime-claim.test.ts +34 -34
  28. package/dist/extensions/pi-intercom/broker/runtime-claim.ts +21 -21
  29. package/dist/extensions/pi-intercom/cwd.test.ts +40 -40
  30. package/dist/extensions/pi-intercom/cwd.ts +31 -31
  31. package/dist/extensions/pi-intercom/extension-api.ts +44 -44
  32. package/dist/extensions/pi-intercom/format-context.test.ts +31 -31
  33. package/dist/extensions/pi-intercom/format-context.ts +32 -32
  34. package/dist/extensions/pi-intercom/test/overlay-width.test.ts +66 -66
  35. package/dist/extensions/pi-intercom/ui/compose.ts +143 -143
  36. package/dist/extensions/pi-intercom/ui/session-list.ts +166 -166
  37. package/dist/extensions/pi-powerline-footer/bash-mode/shell-session.ts +286 -286
  38. package/dist/extensions/pi-powerline-footer/bash-mode/transcript.ts +108 -108
  39. package/dist/extensions/pi-powerline-footer/separators.ts +57 -57
  40. package/dist/extensions/pi-powerline-footer/tests/session-usage.test.ts +47 -47
  41. package/dist/extensions/pi-powerline-footer/tests/tps.test.ts +39 -39
  42. package/dist/extensions/pi-powerline-footer/theme.example.json +24 -24
  43. package/dist/extensions/pi-powerline-footer/theme.json +12 -12
  44. package/dist/extensions/pi-powerline-footer/tps.ts +345 -345
  45. package/dist/extensions/pi-rewind-hook/README.md +245 -245
  46. package/dist/extensions/pi-rewind-hook/index.ts +1445 -1445
  47. package/dist/extensions/pi-rewind-hook/package.json +29 -29
  48. package/dist/extensions/pi-subagents/install.mjs +0 -0
  49. package/dist/extensions/pi-web-agent/package.json +31 -31
  50. package/dist/extensions/pi-web-agent/src/backends/config.ts +205 -205
  51. package/dist/extensions/pi-web-agent/src/backends/doctor.ts +136 -136
  52. package/dist/extensions/pi-web-agent/src/backends/factory.ts +152 -152
  53. package/dist/extensions/pi-web-agent/src/backends/settings-reader.ts +25 -25
  54. package/dist/extensions/pi-web-agent/src/cache/ttl-cache.ts +28 -28
  55. package/dist/extensions/pi-web-agent/src/changelog-notice.ts +136 -136
  56. package/dist/extensions/pi-web-agent/src/commands/web-agent-config.ts +946 -946
  57. package/dist/extensions/pi-web-agent/src/extension.ts +126 -126
  58. package/dist/extensions/pi-web-agent/src/extract/readability.ts +118 -118
  59. package/dist/extensions/pi-web-agent/src/fetch/browser-resolution.ts +199 -199
  60. package/dist/extensions/pi-web-agent/src/fetch/firecrawl-fetch.ts +100 -100
  61. package/dist/extensions/pi-web-agent/src/fetch/headless-fetch.ts +117 -117
  62. package/dist/extensions/pi-web-agent/src/fetch/http-fetch.ts +67 -67
  63. package/dist/extensions/pi-web-agent/src/orchestration/answer-synthesizer.ts +60 -60
  64. package/dist/extensions/pi-web-agent/src/orchestration/candidate-selector.ts +50 -50
  65. package/dist/extensions/pi-web-agent/src/orchestration/direct-url.ts +52 -52
  66. package/dist/extensions/pi-web-agent/src/orchestration/evidence-quality.ts +105 -105
  67. package/dist/extensions/pi-web-agent/src/orchestration/evidence-ranker.ts +45 -45
  68. package/dist/extensions/pi-web-agent/src/orchestration/index.ts +28 -28
  69. package/dist/extensions/pi-web-agent/src/orchestration/query-planner.ts +47 -47
  70. package/dist/extensions/pi-web-agent/src/orchestration/research-orchestrator.ts +376 -376
  71. package/dist/extensions/pi-web-agent/src/orchestration/research-types.ts +64 -64
  72. package/dist/extensions/pi-web-agent/src/orchestration/research-worker.ts +181 -181
  73. package/dist/extensions/pi-web-agent/src/orchestration/source-profile.ts +101 -101
  74. package/dist/extensions/pi-web-agent/src/orchestration/stop-decider.ts +81 -81
  75. package/dist/extensions/pi-web-agent/src/presentation/config-store.ts +210 -210
  76. package/dist/extensions/pi-web-agent/src/presentation/config.ts +75 -75
  77. package/dist/extensions/pi-web-agent/src/presentation/explore-presentation.ts +61 -61
  78. package/dist/extensions/pi-web-agent/src/presentation/fetch-presentation.ts +54 -54
  79. package/dist/extensions/pi-web-agent/src/presentation/search-presentation.ts +41 -41
  80. package/dist/extensions/pi-web-agent/src/presentation/select-view.ts +20 -20
  81. package/dist/extensions/pi-web-agent/src/presentation/types.ts +63 -63
  82. package/dist/extensions/pi-web-agent/src/search/brave.ts +114 -114
  83. package/dist/extensions/pi-web-agent/src/search/duckduckgo.ts +72 -72
  84. package/dist/extensions/pi-web-agent/src/search/searxng.ts +96 -96
  85. package/dist/extensions/pi-web-agent/src/tools/web-explore.ts +71 -71
  86. package/dist/extensions/pi-web-agent/src/tools/web-fetch-headless.ts +31 -31
  87. package/dist/extensions/pi-web-agent/src/tools/web-fetch.ts +31 -31
  88. package/dist/extensions/pi-web-agent/src/tools/web-search.ts +157 -157
  89. package/dist/extensions/pi-web-agent/src/types.ts +88 -88
  90. package/dist/extensions/ponytail/package.json +8 -8
  91. package/dist/extensions/question/batch.ts +103 -103
  92. package/dist/extensions/question/constants.ts +30 -30
  93. package/dist/extensions/question/helpers.ts +58 -58
  94. package/dist/extensions/question/navigation.ts +14 -14
  95. package/dist/extensions/question/package.json +19 -19
  96. package/dist/extensions/question/schemas.ts +43 -43
  97. package/dist/extensions/question/selection-mode.ts +46 -46
  98. package/dist/extensions/question/shortcuts.ts +44 -44
  99. package/dist/extensions/question/types.ts +132 -132
  100. package/dist/extensions/test-resolve-hook-impl.mjs +6 -6
  101. package/dist/extensions/test-resolve-hook.mjs +6 -6
  102. package/dist/extensions/web-agent-onboarding.ts +222 -222
  103. package/dist/extensions/workflow/package.json +17 -17
  104. package/dist/modes/interactive/components/model-selector.d.ts +1 -0
  105. package/dist/modes/interactive/components/model-selector.js +8 -4
  106. package/dist/modes/interactive/interactive-mode.js +9 -5
  107. package/dist/modes/rpc/rpc-mode.js +24 -0
  108. package/dist/modes/rpc/rpc-types.d.ts +19 -0
  109. package/dist/package-manager-cli.js +71 -71
  110. package/dist/rpc-entry.js +0 -0
  111. package/dist/skills/agent-browser/SKILL.md +52 -52
  112. package/dist/skills/batch-grill-me/SKILL.md +19 -19
  113. package/dist/skills/grill-me/SKILL.md +10 -10
  114. package/dist/skills/handoff/SKILL.md +16 -16
  115. package/dist/skills/handoff-text/SKILL.md +14 -14
  116. package/dist/skills/implanger/SKILL.md +69 -69
  117. package/dist/skills/improve-codebase/REFERENCE.md +78 -78
  118. package/dist/skills/improve-codebase/SKILL.md +178 -178
  119. package/dist/skills/planger/SKILL.md +166 -166
  120. package/dist/skills/ponytail/SKILL.md +116 -116
  121. package/dist/skills/ponytail-audit/SKILL.md +42 -42
  122. package/dist/skills/ponytail-debt/SKILL.md +45 -45
  123. package/dist/skills/ponytail-gain/SKILL.md +51 -51
  124. package/dist/skills/ponytail-help/SKILL.md +70 -70
  125. package/dist/skills/ponytail-review/SKILL.md +58 -58
  126. package/dist/skills/selesai-handoff/SKILL.md +20 -20
  127. package/dist/skills/workflow-creation/SKILL.md +73 -73
  128. package/dist/themes/powerline-footer/theme.json +33 -33
  129. package/docs/compaction.md +396 -396
  130. package/docs/containerization.md +111 -111
  131. package/docs/development.md +71 -71
  132. package/docs/docs.json +164 -164
  133. package/docs/environment-variables.md +86 -86
  134. package/docs/index.md +83 -83
  135. package/docs/json.md +82 -82
  136. package/docs/models.md +502 -502
  137. package/docs/packages.md +227 -227
  138. package/docs/plans/subagent-delegation/phase-0-correctness.md +264 -264
  139. package/docs/plans/subagent-delegation/phase-1-behavioral-contract.md +485 -485
  140. package/docs/plans/subagent-delegation/phase-2-context-controls.md +281 -281
  141. package/docs/plans/subagent-delegation/phase-3-advisory-routing.md +361 -361
  142. package/docs/plans/subagent-delegation/phase-4-optional-enforcement.md +380 -380
  143. package/docs/prompt-templates.md +95 -95
  144. package/docs/providers.md +293 -293
  145. package/docs/sdk.md +1143 -1143
  146. package/docs/security.md +59 -59
  147. package/docs/session-format.md +414 -414
  148. package/docs/sessions.md +145 -145
  149. package/docs/shared-host-extensions.md +109 -109
  150. package/docs/shell-aliases.md +13 -13
  151. package/docs/skills.md +231 -231
  152. package/docs/terminal-setup.md +142 -142
  153. package/docs/termux.md +127 -127
  154. package/docs/themes.md +295 -295
  155. package/docs/tmux.md +63 -63
  156. package/docs/tui.md +927 -927
  157. package/docs/windows.md +17 -17
  158. package/examples/README.md +25 -25
  159. package/examples/extensions/README.md +211 -211
  160. package/examples/extensions/auto-commit-on-exit.ts +49 -49
  161. package/examples/extensions/bash-spawn-hook.ts +30 -30
  162. package/examples/extensions/bookmark.ts +50 -50
  163. package/examples/extensions/border-status-editor.ts +150 -150
  164. package/examples/extensions/built-in-tool-renderer.ts +249 -249
  165. package/examples/extensions/claude-rules.ts +86 -86
  166. package/examples/extensions/commands.ts +72 -72
  167. package/examples/extensions/confirm-destructive.ts +59 -59
  168. package/examples/extensions/custom-compaction.ts +130 -130
  169. package/examples/extensions/custom-footer.ts +64 -64
  170. package/examples/extensions/custom-header.ts +73 -73
  171. package/examples/extensions/custom-provider-anthropic/index.ts +610 -610
  172. package/examples/extensions/custom-provider-anthropic/package-lock.json +24 -24
  173. package/examples/extensions/custom-provider-anthropic/package.json +19 -19
  174. package/examples/extensions/custom-provider-gitlab-duo/index.ts +404 -404
  175. package/examples/extensions/custom-provider-gitlab-duo/package.json +16 -16
  176. package/examples/extensions/custom-provider-gitlab-duo/test.ts +82 -82
  177. package/examples/extensions/dirty-repo-guard.ts +56 -56
  178. package/examples/extensions/doom-overlay/README.md +46 -46
  179. package/examples/extensions/doom-overlay/doom/build/doom.js +21 -21
  180. package/examples/extensions/doom-overlay/doom/build/doom.wasm +0 -0
  181. package/examples/extensions/doom-overlay/doom/build.sh +152 -152
  182. package/examples/extensions/doom-overlay/doom/doomgeneric_pi.c +72 -72
  183. package/examples/extensions/doom-overlay/doom-component.ts +132 -132
  184. package/examples/extensions/doom-overlay/doom-engine.ts +173 -173
  185. package/examples/extensions/doom-overlay/doom-keys.ts +104 -104
  186. package/examples/extensions/doom-overlay/index.ts +74 -74
  187. package/examples/extensions/doom-overlay/wad-finder.ts +51 -51
  188. package/examples/extensions/dynamic-resources/SKILL.md +8 -8
  189. package/examples/extensions/dynamic-resources/dynamic.json +79 -79
  190. package/examples/extensions/dynamic-resources/dynamic.md +5 -5
  191. package/examples/extensions/dynamic-resources/index.ts +15 -15
  192. package/examples/extensions/dynamic-tools.ts +74 -74
  193. package/examples/extensions/event-bus.ts +43 -43
  194. package/examples/extensions/file-trigger.ts +41 -41
  195. package/examples/extensions/git-checkpoint.ts +53 -53
  196. package/examples/extensions/git-merge-and-resolve.ts +115 -115
  197. package/examples/extensions/github-issue-autocomplete.ts +185 -185
  198. package/examples/extensions/gondolin/index.ts +531 -531
  199. package/examples/extensions/gondolin/package-lock.json +185 -185
  200. package/examples/extensions/gondolin/package.json +19 -19
  201. package/examples/extensions/handoff.ts +199 -199
  202. package/examples/extensions/hello.ts +26 -26
  203. package/examples/extensions/hidden-thinking-label.ts +53 -53
  204. package/examples/extensions/inline-bash.ts +94 -94
  205. package/examples/extensions/input-transform-streaming.ts +39 -39
  206. package/examples/extensions/input-transform.ts +43 -43
  207. package/examples/extensions/interactive-shell.ts +196 -196
  208. package/examples/extensions/mac-system-theme.ts +47 -47
  209. package/examples/extensions/message-renderer.ts +59 -59
  210. package/examples/extensions/minimal-mode.ts +426 -426
  211. package/examples/extensions/modal-editor.ts +85 -85
  212. package/examples/extensions/model-status.ts +31 -31
  213. package/examples/extensions/notify.ts +55 -55
  214. package/examples/extensions/overlay-qa-tests.ts +1450 -1450
  215. package/examples/extensions/overlay-test.ts +153 -153
  216. package/examples/extensions/permission-gate.ts +34 -34
  217. package/examples/extensions/pirate.ts +47 -47
  218. package/examples/extensions/plan-mode/README.md +66 -66
  219. package/examples/extensions/plan-mode/index.ts +390 -390
  220. package/examples/extensions/plan-mode/utils.ts +168 -168
  221. package/examples/extensions/preset.ts +436 -436
  222. package/examples/extensions/project-trust.ts +64 -64
  223. package/examples/extensions/prompt-customizer.ts +97 -97
  224. package/examples/extensions/protected-paths.ts +30 -30
  225. package/examples/extensions/provider-payload.ts +18 -18
  226. package/examples/extensions/qna.ts +122 -122
  227. package/examples/extensions/question.ts +285 -285
  228. package/examples/extensions/questionnaire.ts +448 -448
  229. package/examples/extensions/rainbow-editor.ts +88 -88
  230. package/examples/extensions/reload-runtime.ts +37 -37
  231. package/examples/extensions/rpc-demo.ts +118 -118
  232. package/examples/extensions/sandbox/index.ts +321 -321
  233. package/examples/extensions/sandbox/package-lock.json +92 -92
  234. package/examples/extensions/sandbox/package.json +19 -19
  235. package/examples/extensions/send-user-message.ts +97 -97
  236. package/examples/extensions/session-name.ts +27 -27
  237. package/examples/extensions/shutdown-command.ts +63 -63
  238. package/examples/extensions/snake.ts +343 -343
  239. package/examples/extensions/space-invaders.ts +560 -560
  240. package/examples/extensions/ssh.ts +220 -220
  241. package/examples/extensions/status-line.ts +32 -32
  242. package/examples/extensions/structured-output.ts +65 -65
  243. package/examples/extensions/subagent/README.md +175 -175
  244. package/examples/extensions/subagent/agents/planner.md +37 -37
  245. package/examples/extensions/subagent/agents/reviewer.md +35 -35
  246. package/examples/extensions/subagent/agents/scout.md +50 -50
  247. package/examples/extensions/subagent/agents/worker.md +24 -24
  248. package/examples/extensions/subagent/agents.ts +126 -126
  249. package/examples/extensions/subagent/index.ts +1015 -1015
  250. package/examples/extensions/subagent/prompts/implement-and-review.md +10 -10
  251. package/examples/extensions/subagent/prompts/implement.md +10 -10
  252. package/examples/extensions/subagent/prompts/scout-and-plan.md +9 -9
  253. package/examples/extensions/summarize.ts +209 -209
  254. package/examples/extensions/system-prompt-header.ts +17 -17
  255. package/examples/extensions/tic-tac-toe.ts +1008 -1008
  256. package/examples/extensions/timed-confirm.ts +70 -70
  257. package/examples/extensions/titlebar-spinner.ts +58 -58
  258. package/examples/extensions/todo.ts +297 -297
  259. package/examples/extensions/tool-override.ts +144 -144
  260. package/examples/extensions/tools.ts +146 -146
  261. package/examples/extensions/trigger-compact.ts +50 -50
  262. package/examples/extensions/truncated-tool.ts +195 -195
  263. package/examples/extensions/widget-placement.ts +9 -9
  264. package/examples/extensions/with-deps/index.ts +32 -32
  265. package/examples/extensions/with-deps/package-lock.json +31 -31
  266. package/examples/extensions/with-deps/package.json +22 -22
  267. package/examples/extensions/working-indicator.ts +123 -123
  268. package/examples/extensions/working-message-test.ts +25 -25
  269. package/examples/rpc-extension-ui.ts +632 -632
  270. package/examples/sdk/01-minimal.ts +26 -26
  271. package/examples/sdk/02-custom-model.ts +53 -53
  272. package/examples/sdk/03-custom-prompt.ts +75 -75
  273. package/examples/sdk/04-skills.ts +55 -55
  274. package/examples/sdk/05-tools.ts +48 -48
  275. package/examples/sdk/06-extensions.ts +99 -99
  276. package/examples/sdk/07-context-files.ts +47 -47
  277. package/examples/sdk/08-prompt-templates.ts +51 -51
  278. package/examples/sdk/09-api-keys-and-oauth.ts +52 -52
  279. package/examples/sdk/10-settings.ts +53 -53
  280. package/examples/sdk/11-sessions.ts +52 -52
  281. package/examples/sdk/12-full-control.ts +79 -79
  282. package/examples/sdk/13-session-runtime.ts +67 -67
  283. package/examples/sdk/README.md +144 -144
  284. package/package.json +1 -1
@@ -1,144 +1,144 @@
1
- /**
2
- * Tool Override Example - Demonstrates overriding built-in tools
3
- *
4
- * Extensions can register tools with the same name as built-in tools to replace them.
5
- * This is useful for:
6
- * - Adding logging or auditing to tool calls
7
- * - Implementing access control or sandboxing
8
- * - Routing tool calls to remote systems (e.g., pi-ssh-remote)
9
- * - Modifying tool behavior for specific workflows
10
- *
11
- * This example overrides the `read` tool to:
12
- * 1. Log all file access to a log file
13
- * 2. Block access to sensitive paths (e.g., .env files)
14
- * 3. Delegate to the original read implementation for allowed files
15
- *
16
- * Since no custom renderCall/renderResult are provided, the built-in renderer
17
- * is used automatically (syntax highlighting, line numbers, truncation warnings).
18
- *
19
- * Usage:
20
- * pi -e ./tool-override.ts
21
- */
22
-
23
- import type { TextContent } from "@earendil-works/pi-ai";
24
- import { type ExtensionAPI, getAgentDir, withFileMutationQueue } from "@earendil-works/pi-coding-agent";
25
- import { constants, readFileSync } from "fs";
26
- import { access, appendFile, readFile } from "fs/promises";
27
- import { join, resolve } from "path";
28
- import { Type } from "typebox";
29
-
30
- const LOG_FILE = join(getAgentDir(), "read-access.log");
31
-
32
- // Paths that are blocked from reading
33
- const BLOCKED_PATTERNS = [
34
- /\.env$/,
35
- /\.env\..+$/,
36
- /secrets?\.(json|yaml|yml|toml)$/i,
37
- /credentials?\.(json|yaml|yml|toml)$/i,
38
- /\/\.ssh\//,
39
- /\/\.aws\//,
40
- /\/\.gnupg\//,
41
- ];
42
-
43
- function isBlockedPath(path: string): boolean {
44
- return BLOCKED_PATTERNS.some((pattern) => pattern.test(path));
45
- }
46
-
47
- async function logAccess(path: string, allowed: boolean, reason?: string) {
48
- const timestamp = new Date().toISOString();
49
- const status = allowed ? "ALLOWED" : "BLOCKED";
50
- const msg = reason ? ` (${reason})` : "";
51
- const line = `[${timestamp}] ${status}: ${path}${msg}\n`;
52
-
53
- try {
54
- await withFileMutationQueue(LOG_FILE, async () => {
55
- await appendFile(LOG_FILE, line);
56
- });
57
- } catch {
58
- // Ignore logging errors
59
- }
60
- }
61
-
62
- const readSchema = Type.Object({
63
- path: Type.String({ description: "Path to the file to read (relative or absolute)" }),
64
- offset: Type.Optional(Type.Number({ description: "Line number to start reading from (1-indexed)" })),
65
- limit: Type.Optional(Type.Number({ description: "Maximum number of lines to read" })),
66
- });
67
-
68
- export default function (pi: ExtensionAPI) {
69
- pi.registerTool({
70
- name: "read", // Same name as built-in - this will override it
71
- label: "read (audited)",
72
- description:
73
- "Read the contents of a file with access logging. Some sensitive paths (.env, secrets, credentials) are blocked.",
74
- parameters: readSchema,
75
-
76
- async execute(_toolCallId, params, _signal, _onUpdate, ctx) {
77
- const { path, offset, limit } = params;
78
- const absolutePath = resolve(ctx.cwd, path);
79
-
80
- // Check if path is blocked
81
- if (isBlockedPath(absolutePath)) {
82
- await logAccess(absolutePath, false, "matches blocked pattern");
83
- return {
84
- content: [
85
- {
86
- type: "text",
87
- text: `Access denied: "${path}" matches a blocked pattern (sensitive file). This tool blocks access to .env files, secrets, credentials, and SSH/AWS/GPG directories.`,
88
- },
89
- ],
90
- details: { blocked: true },
91
- };
92
- }
93
-
94
- // Log allowed access
95
- await logAccess(absolutePath, true);
96
-
97
- // Perform the actual read (simplified implementation)
98
- try {
99
- await access(absolutePath, constants.R_OK);
100
- const content = await readFile(absolutePath, "utf-8");
101
- const lines = content.split("\n");
102
-
103
- // Apply offset and limit
104
- const startLine = offset ? Math.max(0, offset - 1) : 0;
105
- const endLine = limit ? startLine + limit : lines.length;
106
- const selectedLines = lines.slice(startLine, endLine);
107
-
108
- // Basic truncation (50KB limit)
109
- let text = selectedLines.join("\n");
110
- const maxBytes = 50 * 1024;
111
- if (Buffer.byteLength(text, "utf-8") > maxBytes) {
112
- text = `${text.slice(0, maxBytes)}\n\n[Output truncated at 50KB]`;
113
- }
114
-
115
- return {
116
- content: [{ type: "text", text }] as TextContent[],
117
- details: { lines: lines.length },
118
- };
119
- } catch (error: any) {
120
- return {
121
- content: [{ type: "text", text: `Error reading file: ${error.message}` }] as TextContent[],
122
- details: { error: true },
123
- };
124
- }
125
- },
126
-
127
- // No renderCall/renderResult - uses built-in renderer automatically
128
- // (syntax highlighting, line numbers, truncation warnings, etc.)
129
- });
130
-
131
- // Also register a command to view the access log
132
- pi.registerCommand("read-log", {
133
- description: "View the file access log",
134
- handler: async (_args, ctx) => {
135
- try {
136
- const log = readFileSync(LOG_FILE, "utf-8");
137
- const lines = log.trim().split("\n").slice(-20); // Last 20 entries
138
- ctx.ui.notify(`Recent file access:\n${lines.join("\n")}`, "info");
139
- } catch {
140
- ctx.ui.notify("No access log found", "info");
141
- }
142
- },
143
- });
144
- }
1
+ /**
2
+ * Tool Override Example - Demonstrates overriding built-in tools
3
+ *
4
+ * Extensions can register tools with the same name as built-in tools to replace them.
5
+ * This is useful for:
6
+ * - Adding logging or auditing to tool calls
7
+ * - Implementing access control or sandboxing
8
+ * - Routing tool calls to remote systems (e.g., pi-ssh-remote)
9
+ * - Modifying tool behavior for specific workflows
10
+ *
11
+ * This example overrides the `read` tool to:
12
+ * 1. Log all file access to a log file
13
+ * 2. Block access to sensitive paths (e.g., .env files)
14
+ * 3. Delegate to the original read implementation for allowed files
15
+ *
16
+ * Since no custom renderCall/renderResult are provided, the built-in renderer
17
+ * is used automatically (syntax highlighting, line numbers, truncation warnings).
18
+ *
19
+ * Usage:
20
+ * pi -e ./tool-override.ts
21
+ */
22
+
23
+ import type { TextContent } from "@earendil-works/pi-ai";
24
+ import { type ExtensionAPI, getAgentDir, withFileMutationQueue } from "@earendil-works/pi-coding-agent";
25
+ import { constants, readFileSync } from "fs";
26
+ import { access, appendFile, readFile } from "fs/promises";
27
+ import { join, resolve } from "path";
28
+ import { Type } from "typebox";
29
+
30
+ const LOG_FILE = join(getAgentDir(), "read-access.log");
31
+
32
+ // Paths that are blocked from reading
33
+ const BLOCKED_PATTERNS = [
34
+ /\.env$/,
35
+ /\.env\..+$/,
36
+ /secrets?\.(json|yaml|yml|toml)$/i,
37
+ /credentials?\.(json|yaml|yml|toml)$/i,
38
+ /\/\.ssh\//,
39
+ /\/\.aws\//,
40
+ /\/\.gnupg\//,
41
+ ];
42
+
43
+ function isBlockedPath(path: string): boolean {
44
+ return BLOCKED_PATTERNS.some((pattern) => pattern.test(path));
45
+ }
46
+
47
+ async function logAccess(path: string, allowed: boolean, reason?: string) {
48
+ const timestamp = new Date().toISOString();
49
+ const status = allowed ? "ALLOWED" : "BLOCKED";
50
+ const msg = reason ? ` (${reason})` : "";
51
+ const line = `[${timestamp}] ${status}: ${path}${msg}\n`;
52
+
53
+ try {
54
+ await withFileMutationQueue(LOG_FILE, async () => {
55
+ await appendFile(LOG_FILE, line);
56
+ });
57
+ } catch {
58
+ // Ignore logging errors
59
+ }
60
+ }
61
+
62
+ const readSchema = Type.Object({
63
+ path: Type.String({ description: "Path to the file to read (relative or absolute)" }),
64
+ offset: Type.Optional(Type.Number({ description: "Line number to start reading from (1-indexed)" })),
65
+ limit: Type.Optional(Type.Number({ description: "Maximum number of lines to read" })),
66
+ });
67
+
68
+ export default function (pi: ExtensionAPI) {
69
+ pi.registerTool({
70
+ name: "read", // Same name as built-in - this will override it
71
+ label: "read (audited)",
72
+ description:
73
+ "Read the contents of a file with access logging. Some sensitive paths (.env, secrets, credentials) are blocked.",
74
+ parameters: readSchema,
75
+
76
+ async execute(_toolCallId, params, _signal, _onUpdate, ctx) {
77
+ const { path, offset, limit } = params;
78
+ const absolutePath = resolve(ctx.cwd, path);
79
+
80
+ // Check if path is blocked
81
+ if (isBlockedPath(absolutePath)) {
82
+ await logAccess(absolutePath, false, "matches blocked pattern");
83
+ return {
84
+ content: [
85
+ {
86
+ type: "text",
87
+ text: `Access denied: "${path}" matches a blocked pattern (sensitive file). This tool blocks access to .env files, secrets, credentials, and SSH/AWS/GPG directories.`,
88
+ },
89
+ ],
90
+ details: { blocked: true },
91
+ };
92
+ }
93
+
94
+ // Log allowed access
95
+ await logAccess(absolutePath, true);
96
+
97
+ // Perform the actual read (simplified implementation)
98
+ try {
99
+ await access(absolutePath, constants.R_OK);
100
+ const content = await readFile(absolutePath, "utf-8");
101
+ const lines = content.split("\n");
102
+
103
+ // Apply offset and limit
104
+ const startLine = offset ? Math.max(0, offset - 1) : 0;
105
+ const endLine = limit ? startLine + limit : lines.length;
106
+ const selectedLines = lines.slice(startLine, endLine);
107
+
108
+ // Basic truncation (50KB limit)
109
+ let text = selectedLines.join("\n");
110
+ const maxBytes = 50 * 1024;
111
+ if (Buffer.byteLength(text, "utf-8") > maxBytes) {
112
+ text = `${text.slice(0, maxBytes)}\n\n[Output truncated at 50KB]`;
113
+ }
114
+
115
+ return {
116
+ content: [{ type: "text", text }] as TextContent[],
117
+ details: { lines: lines.length },
118
+ };
119
+ } catch (error: any) {
120
+ return {
121
+ content: [{ type: "text", text: `Error reading file: ${error.message}` }] as TextContent[],
122
+ details: { error: true },
123
+ };
124
+ }
125
+ },
126
+
127
+ // No renderCall/renderResult - uses built-in renderer automatically
128
+ // (syntax highlighting, line numbers, truncation warnings, etc.)
129
+ });
130
+
131
+ // Also register a command to view the access log
132
+ pi.registerCommand("read-log", {
133
+ description: "View the file access log",
134
+ handler: async (_args, ctx) => {
135
+ try {
136
+ const log = readFileSync(LOG_FILE, "utf-8");
137
+ const lines = log.trim().split("\n").slice(-20); // Last 20 entries
138
+ ctx.ui.notify(`Recent file access:\n${lines.join("\n")}`, "info");
139
+ } catch {
140
+ ctx.ui.notify("No access log found", "info");
141
+ }
142
+ },
143
+ });
144
+ }
@@ -1,146 +1,146 @@
1
- /**
2
- * Tools Extension
3
- *
4
- * Provides a /tools command to enable/disable tools interactively.
5
- * Tool selection persists across session reloads and respects branch navigation.
6
- *
7
- * Usage:
8
- * 1. Copy this file to ~/.pi/agent/extensions/ or your project's .pi/extensions/
9
- * 2. Use /tools to open the tool selector
10
- */
11
-
12
- import type { ExtensionAPI, ExtensionContext, ToolInfo } from "@earendil-works/pi-coding-agent";
13
- import { getSettingsListTheme } from "@earendil-works/pi-coding-agent";
14
- import { Container, type SettingItem, SettingsList } from "@earendil-works/pi-tui";
15
-
16
- // State persisted to session
17
- interface ToolsState {
18
- enabledTools: string[];
19
- }
20
-
21
- export default function toolsExtension(pi: ExtensionAPI) {
22
- // Track enabled tools
23
- let enabledTools: Set<string> = new Set();
24
- let allTools: ToolInfo[] = [];
25
-
26
- // Persist current state
27
- function persistState() {
28
- pi.appendEntry<ToolsState>("tools-config", {
29
- enabledTools: Array.from(enabledTools),
30
- });
31
- }
32
-
33
- // Apply current tool selection
34
- function applyTools() {
35
- pi.setActiveTools(Array.from(enabledTools));
36
- }
37
-
38
- // Find the last tools-config entry in the current branch
39
- function restoreFromBranch(ctx: ExtensionContext) {
40
- allTools = pi.getAllTools();
41
-
42
- // Get entries in current branch only
43
- const branchEntries = ctx.sessionManager.getBranch();
44
- let savedTools: string[] | undefined;
45
-
46
- for (const entry of branchEntries) {
47
- if (entry.type === "custom" && entry.customType === "tools-config") {
48
- const data = entry.data as ToolsState | undefined;
49
- if (data?.enabledTools) {
50
- savedTools = data.enabledTools;
51
- }
52
- }
53
- }
54
-
55
- if (savedTools) {
56
- // Restore saved tool selection (filter to only tools that still exist)
57
- const allToolNames = allTools.map((t) => t.name);
58
- enabledTools = new Set(savedTools.filter((t: string) => allToolNames.includes(t)));
59
- applyTools();
60
- } else {
61
- // No saved state - sync with currently active tools
62
- enabledTools = new Set(pi.getActiveTools());
63
- }
64
- }
65
-
66
- // Register /tools command
67
- pi.registerCommand("tools", {
68
- description: "Enable/disable tools",
69
- handler: async (_args, ctx) => {
70
- if (ctx.mode !== "tui") {
71
- ctx.ui.notify("/tools requires TUI mode", "error");
72
- return;
73
- }
74
-
75
- // Refresh tool list
76
- allTools = pi.getAllTools();
77
-
78
- await ctx.ui.custom((tui, theme, _kb, done) => {
79
- // Build settings items for each tool
80
- const items: SettingItem[] = allTools.map((tool) => ({
81
- id: tool.name,
82
- label: tool.name,
83
- currentValue: enabledTools.has(tool.name) ? "enabled" : "disabled",
84
- values: ["enabled", "disabled"],
85
- }));
86
-
87
- const container = new Container();
88
- container.addChild(
89
- new (class {
90
- render(_width: number) {
91
- return [theme.fg("accent", theme.bold("Tool Configuration")), ""];
92
- }
93
- invalidate() {}
94
- })(),
95
- );
96
-
97
- const settingsList = new SettingsList(
98
- items,
99
- Math.min(items.length + 2, 15),
100
- getSettingsListTheme(),
101
- (id, newValue) => {
102
- // Update enabled state and apply immediately
103
- if (newValue === "enabled") {
104
- enabledTools.add(id);
105
- } else {
106
- enabledTools.delete(id);
107
- }
108
- applyTools();
109
- persistState();
110
- },
111
- () => {
112
- // Close dialog
113
- done(undefined);
114
- },
115
- );
116
-
117
- container.addChild(settingsList);
118
-
119
- const component = {
120
- render(width: number) {
121
- return container.render(width);
122
- },
123
- invalidate() {
124
- container.invalidate();
125
- },
126
- handleInput(data: string) {
127
- settingsList.handleInput?.(data);
128
- tui.requestRender();
129
- },
130
- };
131
-
132
- return component;
133
- });
134
- },
135
- });
136
-
137
- // Restore state on session start
138
- pi.on("session_start", async (_event, ctx) => {
139
- restoreFromBranch(ctx);
140
- });
141
-
142
- // Restore state when navigating the session tree
143
- pi.on("session_tree", async (_event, ctx) => {
144
- restoreFromBranch(ctx);
145
- });
146
- }
1
+ /**
2
+ * Tools Extension
3
+ *
4
+ * Provides a /tools command to enable/disable tools interactively.
5
+ * Tool selection persists across session reloads and respects branch navigation.
6
+ *
7
+ * Usage:
8
+ * 1. Copy this file to ~/.pi/agent/extensions/ or your project's .pi/extensions/
9
+ * 2. Use /tools to open the tool selector
10
+ */
11
+
12
+ import type { ExtensionAPI, ExtensionContext, ToolInfo } from "@earendil-works/pi-coding-agent";
13
+ import { getSettingsListTheme } from "@earendil-works/pi-coding-agent";
14
+ import { Container, type SettingItem, SettingsList } from "@earendil-works/pi-tui";
15
+
16
+ // State persisted to session
17
+ interface ToolsState {
18
+ enabledTools: string[];
19
+ }
20
+
21
+ export default function toolsExtension(pi: ExtensionAPI) {
22
+ // Track enabled tools
23
+ let enabledTools: Set<string> = new Set();
24
+ let allTools: ToolInfo[] = [];
25
+
26
+ // Persist current state
27
+ function persistState() {
28
+ pi.appendEntry<ToolsState>("tools-config", {
29
+ enabledTools: Array.from(enabledTools),
30
+ });
31
+ }
32
+
33
+ // Apply current tool selection
34
+ function applyTools() {
35
+ pi.setActiveTools(Array.from(enabledTools));
36
+ }
37
+
38
+ // Find the last tools-config entry in the current branch
39
+ function restoreFromBranch(ctx: ExtensionContext) {
40
+ allTools = pi.getAllTools();
41
+
42
+ // Get entries in current branch only
43
+ const branchEntries = ctx.sessionManager.getBranch();
44
+ let savedTools: string[] | undefined;
45
+
46
+ for (const entry of branchEntries) {
47
+ if (entry.type === "custom" && entry.customType === "tools-config") {
48
+ const data = entry.data as ToolsState | undefined;
49
+ if (data?.enabledTools) {
50
+ savedTools = data.enabledTools;
51
+ }
52
+ }
53
+ }
54
+
55
+ if (savedTools) {
56
+ // Restore saved tool selection (filter to only tools that still exist)
57
+ const allToolNames = allTools.map((t) => t.name);
58
+ enabledTools = new Set(savedTools.filter((t: string) => allToolNames.includes(t)));
59
+ applyTools();
60
+ } else {
61
+ // No saved state - sync with currently active tools
62
+ enabledTools = new Set(pi.getActiveTools());
63
+ }
64
+ }
65
+
66
+ // Register /tools command
67
+ pi.registerCommand("tools", {
68
+ description: "Enable/disable tools",
69
+ handler: async (_args, ctx) => {
70
+ if (ctx.mode !== "tui") {
71
+ ctx.ui.notify("/tools requires TUI mode", "error");
72
+ return;
73
+ }
74
+
75
+ // Refresh tool list
76
+ allTools = pi.getAllTools();
77
+
78
+ await ctx.ui.custom((tui, theme, _kb, done) => {
79
+ // Build settings items for each tool
80
+ const items: SettingItem[] = allTools.map((tool) => ({
81
+ id: tool.name,
82
+ label: tool.name,
83
+ currentValue: enabledTools.has(tool.name) ? "enabled" : "disabled",
84
+ values: ["enabled", "disabled"],
85
+ }));
86
+
87
+ const container = new Container();
88
+ container.addChild(
89
+ new (class {
90
+ render(_width: number) {
91
+ return [theme.fg("accent", theme.bold("Tool Configuration")), ""];
92
+ }
93
+ invalidate() {}
94
+ })(),
95
+ );
96
+
97
+ const settingsList = new SettingsList(
98
+ items,
99
+ Math.min(items.length + 2, 15),
100
+ getSettingsListTheme(),
101
+ (id, newValue) => {
102
+ // Update enabled state and apply immediately
103
+ if (newValue === "enabled") {
104
+ enabledTools.add(id);
105
+ } else {
106
+ enabledTools.delete(id);
107
+ }
108
+ applyTools();
109
+ persistState();
110
+ },
111
+ () => {
112
+ // Close dialog
113
+ done(undefined);
114
+ },
115
+ );
116
+
117
+ container.addChild(settingsList);
118
+
119
+ const component = {
120
+ render(width: number) {
121
+ return container.render(width);
122
+ },
123
+ invalidate() {
124
+ container.invalidate();
125
+ },
126
+ handleInput(data: string) {
127
+ settingsList.handleInput?.(data);
128
+ tui.requestRender();
129
+ },
130
+ };
131
+
132
+ return component;
133
+ });
134
+ },
135
+ });
136
+
137
+ // Restore state on session start
138
+ pi.on("session_start", async (_event, ctx) => {
139
+ restoreFromBranch(ctx);
140
+ });
141
+
142
+ // Restore state when navigating the session tree
143
+ pi.on("session_tree", async (_event, ctx) => {
144
+ restoreFromBranch(ctx);
145
+ });
146
+ }