@selesai/code 0.9.6 → 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 (281) hide show
  1. package/CHANGELOG.md +13 -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/rpc/rpc-mode.js +24 -0
  105. package/dist/modes/rpc/rpc-types.d.ts +19 -0
  106. package/dist/package-manager-cli.js +71 -71
  107. package/dist/rpc-entry.js +0 -0
  108. package/dist/skills/agent-browser/SKILL.md +52 -52
  109. package/dist/skills/batch-grill-me/SKILL.md +19 -19
  110. package/dist/skills/grill-me/SKILL.md +10 -10
  111. package/dist/skills/handoff/SKILL.md +16 -16
  112. package/dist/skills/handoff-text/SKILL.md +14 -14
  113. package/dist/skills/implanger/SKILL.md +69 -69
  114. package/dist/skills/improve-codebase/REFERENCE.md +78 -78
  115. package/dist/skills/improve-codebase/SKILL.md +178 -178
  116. package/dist/skills/planger/SKILL.md +166 -166
  117. package/dist/skills/ponytail/SKILL.md +116 -116
  118. package/dist/skills/ponytail-audit/SKILL.md +42 -42
  119. package/dist/skills/ponytail-debt/SKILL.md +45 -45
  120. package/dist/skills/ponytail-gain/SKILL.md +51 -51
  121. package/dist/skills/ponytail-help/SKILL.md +70 -70
  122. package/dist/skills/ponytail-review/SKILL.md +58 -58
  123. package/dist/skills/selesai-handoff/SKILL.md +20 -20
  124. package/dist/skills/workflow-creation/SKILL.md +73 -73
  125. package/dist/themes/powerline-footer/theme.json +33 -33
  126. package/docs/compaction.md +396 -396
  127. package/docs/containerization.md +111 -111
  128. package/docs/development.md +71 -71
  129. package/docs/docs.json +164 -164
  130. package/docs/environment-variables.md +86 -86
  131. package/docs/index.md +83 -83
  132. package/docs/json.md +82 -82
  133. package/docs/models.md +502 -502
  134. package/docs/packages.md +227 -227
  135. package/docs/plans/subagent-delegation/phase-0-correctness.md +264 -264
  136. package/docs/plans/subagent-delegation/phase-1-behavioral-contract.md +485 -485
  137. package/docs/plans/subagent-delegation/phase-2-context-controls.md +281 -281
  138. package/docs/plans/subagent-delegation/phase-3-advisory-routing.md +361 -361
  139. package/docs/plans/subagent-delegation/phase-4-optional-enforcement.md +380 -380
  140. package/docs/prompt-templates.md +95 -95
  141. package/docs/providers.md +293 -293
  142. package/docs/sdk.md +1143 -1143
  143. package/docs/security.md +59 -59
  144. package/docs/session-format.md +414 -414
  145. package/docs/sessions.md +145 -145
  146. package/docs/shared-host-extensions.md +109 -109
  147. package/docs/shell-aliases.md +13 -13
  148. package/docs/skills.md +231 -231
  149. package/docs/terminal-setup.md +142 -142
  150. package/docs/termux.md +127 -127
  151. package/docs/themes.md +295 -295
  152. package/docs/tmux.md +63 -63
  153. package/docs/tui.md +927 -927
  154. package/docs/windows.md +17 -17
  155. package/examples/README.md +25 -25
  156. package/examples/extensions/README.md +211 -211
  157. package/examples/extensions/auto-commit-on-exit.ts +49 -49
  158. package/examples/extensions/bash-spawn-hook.ts +30 -30
  159. package/examples/extensions/bookmark.ts +50 -50
  160. package/examples/extensions/border-status-editor.ts +150 -150
  161. package/examples/extensions/built-in-tool-renderer.ts +249 -249
  162. package/examples/extensions/claude-rules.ts +86 -86
  163. package/examples/extensions/commands.ts +72 -72
  164. package/examples/extensions/confirm-destructive.ts +59 -59
  165. package/examples/extensions/custom-compaction.ts +130 -130
  166. package/examples/extensions/custom-footer.ts +64 -64
  167. package/examples/extensions/custom-header.ts +73 -73
  168. package/examples/extensions/custom-provider-anthropic/index.ts +610 -610
  169. package/examples/extensions/custom-provider-anthropic/package-lock.json +24 -24
  170. package/examples/extensions/custom-provider-anthropic/package.json +19 -19
  171. package/examples/extensions/custom-provider-gitlab-duo/index.ts +404 -404
  172. package/examples/extensions/custom-provider-gitlab-duo/package.json +16 -16
  173. package/examples/extensions/custom-provider-gitlab-duo/test.ts +82 -82
  174. package/examples/extensions/dirty-repo-guard.ts +56 -56
  175. package/examples/extensions/doom-overlay/README.md +46 -46
  176. package/examples/extensions/doom-overlay/doom/build/doom.js +21 -21
  177. package/examples/extensions/doom-overlay/doom/build/doom.wasm +0 -0
  178. package/examples/extensions/doom-overlay/doom/build.sh +152 -152
  179. package/examples/extensions/doom-overlay/doom/doomgeneric_pi.c +72 -72
  180. package/examples/extensions/doom-overlay/doom-component.ts +132 -132
  181. package/examples/extensions/doom-overlay/doom-engine.ts +173 -173
  182. package/examples/extensions/doom-overlay/doom-keys.ts +104 -104
  183. package/examples/extensions/doom-overlay/index.ts +74 -74
  184. package/examples/extensions/doom-overlay/wad-finder.ts +51 -51
  185. package/examples/extensions/dynamic-resources/SKILL.md +8 -8
  186. package/examples/extensions/dynamic-resources/dynamic.json +79 -79
  187. package/examples/extensions/dynamic-resources/dynamic.md +5 -5
  188. package/examples/extensions/dynamic-resources/index.ts +15 -15
  189. package/examples/extensions/dynamic-tools.ts +74 -74
  190. package/examples/extensions/event-bus.ts +43 -43
  191. package/examples/extensions/file-trigger.ts +41 -41
  192. package/examples/extensions/git-checkpoint.ts +53 -53
  193. package/examples/extensions/git-merge-and-resolve.ts +115 -115
  194. package/examples/extensions/github-issue-autocomplete.ts +185 -185
  195. package/examples/extensions/gondolin/index.ts +531 -531
  196. package/examples/extensions/gondolin/package-lock.json +185 -185
  197. package/examples/extensions/gondolin/package.json +19 -19
  198. package/examples/extensions/handoff.ts +199 -199
  199. package/examples/extensions/hello.ts +26 -26
  200. package/examples/extensions/hidden-thinking-label.ts +53 -53
  201. package/examples/extensions/inline-bash.ts +94 -94
  202. package/examples/extensions/input-transform-streaming.ts +39 -39
  203. package/examples/extensions/input-transform.ts +43 -43
  204. package/examples/extensions/interactive-shell.ts +196 -196
  205. package/examples/extensions/mac-system-theme.ts +47 -47
  206. package/examples/extensions/message-renderer.ts +59 -59
  207. package/examples/extensions/minimal-mode.ts +426 -426
  208. package/examples/extensions/modal-editor.ts +85 -85
  209. package/examples/extensions/model-status.ts +31 -31
  210. package/examples/extensions/notify.ts +55 -55
  211. package/examples/extensions/overlay-qa-tests.ts +1450 -1450
  212. package/examples/extensions/overlay-test.ts +153 -153
  213. package/examples/extensions/permission-gate.ts +34 -34
  214. package/examples/extensions/pirate.ts +47 -47
  215. package/examples/extensions/plan-mode/README.md +66 -66
  216. package/examples/extensions/plan-mode/index.ts +390 -390
  217. package/examples/extensions/plan-mode/utils.ts +168 -168
  218. package/examples/extensions/preset.ts +436 -436
  219. package/examples/extensions/project-trust.ts +64 -64
  220. package/examples/extensions/prompt-customizer.ts +97 -97
  221. package/examples/extensions/protected-paths.ts +30 -30
  222. package/examples/extensions/provider-payload.ts +18 -18
  223. package/examples/extensions/qna.ts +122 -122
  224. package/examples/extensions/question.ts +285 -285
  225. package/examples/extensions/questionnaire.ts +448 -448
  226. package/examples/extensions/rainbow-editor.ts +88 -88
  227. package/examples/extensions/reload-runtime.ts +37 -37
  228. package/examples/extensions/rpc-demo.ts +118 -118
  229. package/examples/extensions/sandbox/index.ts +321 -321
  230. package/examples/extensions/sandbox/package-lock.json +92 -92
  231. package/examples/extensions/sandbox/package.json +19 -19
  232. package/examples/extensions/send-user-message.ts +97 -97
  233. package/examples/extensions/session-name.ts +27 -27
  234. package/examples/extensions/shutdown-command.ts +63 -63
  235. package/examples/extensions/snake.ts +343 -343
  236. package/examples/extensions/space-invaders.ts +560 -560
  237. package/examples/extensions/ssh.ts +220 -220
  238. package/examples/extensions/status-line.ts +32 -32
  239. package/examples/extensions/structured-output.ts +65 -65
  240. package/examples/extensions/subagent/README.md +175 -175
  241. package/examples/extensions/subagent/agents/planner.md +37 -37
  242. package/examples/extensions/subagent/agents/reviewer.md +35 -35
  243. package/examples/extensions/subagent/agents/scout.md +50 -50
  244. package/examples/extensions/subagent/agents/worker.md +24 -24
  245. package/examples/extensions/subagent/agents.ts +126 -126
  246. package/examples/extensions/subagent/index.ts +1015 -1015
  247. package/examples/extensions/subagent/prompts/implement-and-review.md +10 -10
  248. package/examples/extensions/subagent/prompts/implement.md +10 -10
  249. package/examples/extensions/subagent/prompts/scout-and-plan.md +9 -9
  250. package/examples/extensions/summarize.ts +209 -209
  251. package/examples/extensions/system-prompt-header.ts +17 -17
  252. package/examples/extensions/tic-tac-toe.ts +1008 -1008
  253. package/examples/extensions/timed-confirm.ts +70 -70
  254. package/examples/extensions/titlebar-spinner.ts +58 -58
  255. package/examples/extensions/todo.ts +297 -297
  256. package/examples/extensions/tool-override.ts +144 -144
  257. package/examples/extensions/tools.ts +146 -146
  258. package/examples/extensions/trigger-compact.ts +50 -50
  259. package/examples/extensions/truncated-tool.ts +195 -195
  260. package/examples/extensions/widget-placement.ts +9 -9
  261. package/examples/extensions/with-deps/index.ts +32 -32
  262. package/examples/extensions/with-deps/package-lock.json +31 -31
  263. package/examples/extensions/with-deps/package.json +22 -22
  264. package/examples/extensions/working-indicator.ts +123 -123
  265. package/examples/extensions/working-message-test.ts +25 -25
  266. package/examples/rpc-extension-ui.ts +632 -632
  267. package/examples/sdk/01-minimal.ts +26 -26
  268. package/examples/sdk/02-custom-model.ts +53 -53
  269. package/examples/sdk/03-custom-prompt.ts +75 -75
  270. package/examples/sdk/04-skills.ts +55 -55
  271. package/examples/sdk/05-tools.ts +48 -48
  272. package/examples/sdk/06-extensions.ts +99 -99
  273. package/examples/sdk/07-context-files.ts +47 -47
  274. package/examples/sdk/08-prompt-templates.ts +51 -51
  275. package/examples/sdk/09-api-keys-and-oauth.ts +52 -52
  276. package/examples/sdk/10-settings.ts +53 -53
  277. package/examples/sdk/11-sessions.ts +52 -52
  278. package/examples/sdk/12-full-control.ts +79 -79
  279. package/examples/sdk/13-session-runtime.ts +67 -67
  280. package/examples/sdk/README.md +144 -144
  281. package/package.json +1 -1
@@ -1,111 +1,111 @@
1
- # Containerization
2
-
3
- Pi runs with all permissions by default, but in some cases, you will want to have more control over what directories Pi can write to and which accesses it has.
4
-
5
- There are two general options. You can either
6
- 1. run the whole `pi` process inside an isolated environment, or
7
- 2. run `pi` on the host and route tool execution into an isolated environment.
8
-
9
- ## Choose a pattern
10
-
11
- | Pattern | What is isolated | Best for | Notes |
12
- | --- | --- | --- | --- |
13
- | Gondolin extension | Built-in tools and `!` commands | Local micro-VM isolation while keeping auth on host | See [`examples/extensions/gondolin/`](../examples/extensions/gondolin/). |
14
- | Plain Docker | Whole `pi` process in a local container | Simple local isolation | Provider API keys enter the container. |
15
- | OpenShell | Whole `pi` process in a policy-controlled sandbox | Local or remote managed sandbox | Requires an OpenShell gateway |
16
-
17
- Extensions run wherever the `pi` process runs. If you run host `pi` with a tool-routing extension, other custom extension tools still run on the host unless they also delegate their operations.
18
-
19
- ## Gondolin
20
-
21
- [Gondolin](https://github.com/earendil-works/gondolin) is a local Linux micro-VM.
22
- Use the [example extension](../examples/extensions/gondolin) when you want `pi` on the host but all built-in tools routed into the VM.
23
-
24
- Setup:
25
-
26
- ```bash
27
- cp -R packages/coding-agent/examples/extensions/gondolin ~/.pi/agent/extensions/gondolin
28
- cd ~/.pi/agent/extensions/gondolin
29
- npm install --ignore-scripts
30
- ```
31
-
32
- Run from the project you want mounted:
33
-
34
- ```bash
35
- cd /path/to/project
36
- pi -e ~/.pi/agent/extensions/gondolin
37
- ```
38
-
39
- The extension mounts the host cwd at `/workspace` in the VM and overrides `read`, `write`, `edit`, `bash`, `grep`, `find`, and `ls`.
40
- User `!` commands are routed into the VM, as well.
41
- File changes under `/workspace` write through to the host.
42
-
43
- Requirements: Node.js >= 23.6.0 for `@earendil-works/gondolin`, plus QEMU (requires installation through your package manager).
44
-
45
- ## Plain Docker
46
-
47
- Run the whole `pi` process in Docker when you want the simplest local container boundary.
48
-
49
- `Dockerfile.pi`:
50
-
51
- ```dockerfile
52
- FROM node:24-bookworm-slim
53
-
54
- RUN apt-get update \
55
- && apt-get install -y --no-install-recommends bash ca-certificates git ripgrep \
56
- && rm -rf /var/lib/apt/lists/*
57
- RUN npm install -g --ignore-scripts @earendil-works/pi-coding-agent
58
-
59
- WORKDIR /workspace
60
- ENTRYPOINT ["pi"]
61
- ```
62
-
63
- Build and run:
64
-
65
- ```bash
66
- docker build -t pi-sandbox -f Dockerfile.pi .
67
-
68
- docker run --rm -it \
69
- -e ANTHROPIC_API_KEY \
70
- -v "$PWD:/workspace" \
71
- -v pi-agent-home:/root/.pi/agent \
72
- pi-sandbox
73
- ```
74
-
75
- The `-v "$PWD:/workspace"` mounts your current directory into the container at /workspace such that reads and writes in `/workspace` inside Docker directly affect your host files, like in the Gondolin example.
76
-
77
- Use a named volume for `/root/.pi/agent` if you want container-local settings and sessions. Mounting your host `~/.pi/agent` exposes host auth and session files to the container.
78
-
79
- ## OpenShell
80
-
81
- Use [NVIDIA OpenShell](https://docs.nvidia.com/openshell/about/overview) when you want a policy-controlled sandbox with filesystem, process, network, credential, and inference controls.
82
- OpenShell can run sandboxes through a local gateway backed by Docker, Podman, or a VM runtime, or through a remote Kubernetes gateway.
83
-
84
- Every sandbox requires an active gateway.
85
- Register and select one before creating a sandbox:
86
-
87
- ```bash
88
- openshell gateway add <gateway-url> --name <name>
89
- openshell gateway select <name>
90
- ```
91
-
92
- Launch `pi` inside an OpenShell sandbox:
93
-
94
- ```bash
95
- openshell sandbox create --name pi-sandbox --from pi -- pi
96
- ```
97
-
98
- In this pattern, the whole `pi` process runs inside the sandbox.
99
- Built-in tools, `!` commands, and extension tools execute inside the OpenShell boundary.
100
-
101
- If the gateway is remote, project files are not bind-mounted from the host, meaning writes in the sandbox are not reflected on your machine.
102
- Clone the repository inside the sandbox or use OpenShell file transfer commands:
103
-
104
- ```bash
105
- openshell sandbox upload pi-sandbox ./repo /workspace
106
- openshell sandbox download pi-sandbox /workspace/repo ./repo-out
107
- ```
108
-
109
- OpenShell providers can keep raw model API keys outside the sandbox.
110
- When inference routing is configured, code inside the sandbox can call `https://inference.local`, and the gateway injects the configured provider credentials upstream.
111
- Configure Pi to use the corresponding OpenAI-compatible or Anthropic-compatible endpoint if you want model traffic to use this route.
1
+ # Containerization
2
+
3
+ Pi runs with all permissions by default, but in some cases, you will want to have more control over what directories Pi can write to and which accesses it has.
4
+
5
+ There are two general options. You can either
6
+ 1. run the whole `pi` process inside an isolated environment, or
7
+ 2. run `pi` on the host and route tool execution into an isolated environment.
8
+
9
+ ## Choose a pattern
10
+
11
+ | Pattern | What is isolated | Best for | Notes |
12
+ | --- | --- | --- | --- |
13
+ | Gondolin extension | Built-in tools and `!` commands | Local micro-VM isolation while keeping auth on host | See [`examples/extensions/gondolin/`](../examples/extensions/gondolin/). |
14
+ | Plain Docker | Whole `pi` process in a local container | Simple local isolation | Provider API keys enter the container. |
15
+ | OpenShell | Whole `pi` process in a policy-controlled sandbox | Local or remote managed sandbox | Requires an OpenShell gateway |
16
+
17
+ Extensions run wherever the `pi` process runs. If you run host `pi` with a tool-routing extension, other custom extension tools still run on the host unless they also delegate their operations.
18
+
19
+ ## Gondolin
20
+
21
+ [Gondolin](https://github.com/earendil-works/gondolin) is a local Linux micro-VM.
22
+ Use the [example extension](../examples/extensions/gondolin) when you want `pi` on the host but all built-in tools routed into the VM.
23
+
24
+ Setup:
25
+
26
+ ```bash
27
+ cp -R packages/coding-agent/examples/extensions/gondolin ~/.pi/agent/extensions/gondolin
28
+ cd ~/.pi/agent/extensions/gondolin
29
+ npm install --ignore-scripts
30
+ ```
31
+
32
+ Run from the project you want mounted:
33
+
34
+ ```bash
35
+ cd /path/to/project
36
+ pi -e ~/.pi/agent/extensions/gondolin
37
+ ```
38
+
39
+ The extension mounts the host cwd at `/workspace` in the VM and overrides `read`, `write`, `edit`, `bash`, `grep`, `find`, and `ls`.
40
+ User `!` commands are routed into the VM, as well.
41
+ File changes under `/workspace` write through to the host.
42
+
43
+ Requirements: Node.js >= 23.6.0 for `@earendil-works/gondolin`, plus QEMU (requires installation through your package manager).
44
+
45
+ ## Plain Docker
46
+
47
+ Run the whole `pi` process in Docker when you want the simplest local container boundary.
48
+
49
+ `Dockerfile.pi`:
50
+
51
+ ```dockerfile
52
+ FROM node:24-bookworm-slim
53
+
54
+ RUN apt-get update \
55
+ && apt-get install -y --no-install-recommends bash ca-certificates git ripgrep \
56
+ && rm -rf /var/lib/apt/lists/*
57
+ RUN npm install -g --ignore-scripts @earendil-works/pi-coding-agent
58
+
59
+ WORKDIR /workspace
60
+ ENTRYPOINT ["pi"]
61
+ ```
62
+
63
+ Build and run:
64
+
65
+ ```bash
66
+ docker build -t pi-sandbox -f Dockerfile.pi .
67
+
68
+ docker run --rm -it \
69
+ -e ANTHROPIC_API_KEY \
70
+ -v "$PWD:/workspace" \
71
+ -v pi-agent-home:/root/.pi/agent \
72
+ pi-sandbox
73
+ ```
74
+
75
+ The `-v "$PWD:/workspace"` mounts your current directory into the container at /workspace such that reads and writes in `/workspace` inside Docker directly affect your host files, like in the Gondolin example.
76
+
77
+ Use a named volume for `/root/.pi/agent` if you want container-local settings and sessions. Mounting your host `~/.pi/agent` exposes host auth and session files to the container.
78
+
79
+ ## OpenShell
80
+
81
+ Use [NVIDIA OpenShell](https://docs.nvidia.com/openshell/about/overview) when you want a policy-controlled sandbox with filesystem, process, network, credential, and inference controls.
82
+ OpenShell can run sandboxes through a local gateway backed by Docker, Podman, or a VM runtime, or through a remote Kubernetes gateway.
83
+
84
+ Every sandbox requires an active gateway.
85
+ Register and select one before creating a sandbox:
86
+
87
+ ```bash
88
+ openshell gateway add <gateway-url> --name <name>
89
+ openshell gateway select <name>
90
+ ```
91
+
92
+ Launch `pi` inside an OpenShell sandbox:
93
+
94
+ ```bash
95
+ openshell sandbox create --name pi-sandbox --from pi -- pi
96
+ ```
97
+
98
+ In this pattern, the whole `pi` process runs inside the sandbox.
99
+ Built-in tools, `!` commands, and extension tools execute inside the OpenShell boundary.
100
+
101
+ If the gateway is remote, project files are not bind-mounted from the host, meaning writes in the sandbox are not reflected on your machine.
102
+ Clone the repository inside the sandbox or use OpenShell file transfer commands:
103
+
104
+ ```bash
105
+ openshell sandbox upload pi-sandbox ./repo /workspace
106
+ openshell sandbox download pi-sandbox /workspace/repo ./repo-out
107
+ ```
108
+
109
+ OpenShell providers can keep raw model API keys outside the sandbox.
110
+ When inference routing is configured, code inside the sandbox can call `https://inference.local`, and the gateway injects the configured provider credentials upstream.
111
+ Configure Pi to use the corresponding OpenAI-compatible or Anthropic-compatible endpoint if you want model traffic to use this route.
@@ -1,71 +1,71 @@
1
- # Development
2
-
3
- See [AGENTS.md](https://github.com/earendil-works/pi-mono/blob/main/AGENTS.md) for additional guidelines.
4
-
5
- ## Setup
6
-
7
- ```bash
8
- git clone https://github.com/earendil-works/pi-mono
9
- cd pi-mono
10
- npm install
11
- npm run build
12
- ```
13
-
14
- Run from source:
15
-
16
- ```bash
17
- /path/to/pi-mono/pi-test.sh
18
- ```
19
-
20
- The script can be run from any directory. Pi keeps the caller's current working directory.
21
-
22
- ## Forking / Rebranding
23
-
24
- Configure via `package.json`:
25
-
26
- ```json
27
- {
28
- "piConfig": {
29
- "name": "pi",
30
- "configDir": ".pi"
31
- }
32
- }
33
- ```
34
-
35
- Change `name`, `configDir`, and `bin` field for your fork. Affects CLI banner, config paths, and environment variable names.
36
-
37
- ## Path Resolution
38
-
39
- Three execution modes: npm install, standalone binary, tsx from source.
40
-
41
- **Always use `src/config.ts`** for package assets:
42
-
43
- ```typescript
44
- import { getPackageDir, getThemeDir } from "./config.js";
45
- ```
46
-
47
- Never use `__dirname` directly for package assets.
48
-
49
- ## Debug Command
50
-
51
- `/debug` (hidden) writes to `~/.pi/agent/pi-debug.log`:
52
- - Rendered TUI lines with ANSI codes
53
- - Last messages sent to the LLM
54
-
55
- ## Testing
56
-
57
- ```bash
58
- ./test.sh # Run non-LLM tests (no API keys needed)
59
- npm test # Run all tests
60
- npm test -- test/specific.test.ts # Run specific test
61
- ```
62
-
63
- ## Project Structure
64
-
65
- ```
66
- packages/
67
- ai/ # LLM provider abstraction
68
- agent/ # Agent loop and message types
69
- tui/ # Terminal UI components
70
- coding-agent/ # CLI and interactive mode
71
- ```
1
+ # Development
2
+
3
+ See [AGENTS.md](https://github.com/earendil-works/pi-mono/blob/main/AGENTS.md) for additional guidelines.
4
+
5
+ ## Setup
6
+
7
+ ```bash
8
+ git clone https://github.com/earendil-works/pi-mono
9
+ cd pi-mono
10
+ npm install
11
+ npm run build
12
+ ```
13
+
14
+ Run from source:
15
+
16
+ ```bash
17
+ /path/to/pi-mono/pi-test.sh
18
+ ```
19
+
20
+ The script can be run from any directory. Pi keeps the caller's current working directory.
21
+
22
+ ## Forking / Rebranding
23
+
24
+ Configure via `package.json`:
25
+
26
+ ```json
27
+ {
28
+ "piConfig": {
29
+ "name": "pi",
30
+ "configDir": ".pi"
31
+ }
32
+ }
33
+ ```
34
+
35
+ Change `name`, `configDir`, and `bin` field for your fork. Affects CLI banner, config paths, and environment variable names.
36
+
37
+ ## Path Resolution
38
+
39
+ Three execution modes: npm install, standalone binary, tsx from source.
40
+
41
+ **Always use `src/config.ts`** for package assets:
42
+
43
+ ```typescript
44
+ import { getPackageDir, getThemeDir } from "./config.js";
45
+ ```
46
+
47
+ Never use `__dirname` directly for package assets.
48
+
49
+ ## Debug Command
50
+
51
+ `/debug` (hidden) writes to `~/.pi/agent/pi-debug.log`:
52
+ - Rendered TUI lines with ANSI codes
53
+ - Last messages sent to the LLM
54
+
55
+ ## Testing
56
+
57
+ ```bash
58
+ ./test.sh # Run non-LLM tests (no API keys needed)
59
+ npm test # Run all tests
60
+ npm test -- test/specific.test.ts # Run specific test
61
+ ```
62
+
63
+ ## Project Structure
64
+
65
+ ```
66
+ packages/
67
+ ai/ # LLM provider abstraction
68
+ agent/ # Agent loop and message types
69
+ tui/ # Terminal UI components
70
+ coding-agent/ # CLI and interactive mode
71
+ ```