@earendil-works/pi-coding-agent 0.87.0 → 0.87.1

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 (75) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/README.md +25 -711
  3. package/dist/bundle/chunks/{anthropic-messages-MYU5ZMRF.js → anthropic-messages-J5WXPPPC.js} +1 -1
  4. package/dist/bundle/chunks/{chunk-GV2E3GBU.js → chunk-65HAU2C5.js} +1 -1
  5. package/dist/bundle/chunks/{chunk-4DKZACXI.js → chunk-OJP47DM6.js} +13 -13
  6. package/dist/bundle/chunks/github-copilot.js +1 -1
  7. package/dist/bundle/chunks/{openai-completions-XHML6MTL.js → openai-completions-OBX42CLD.js} +1 -1
  8. package/dist/bundle/chunks/{virtual-modules-BNWPZYDH.js → virtual-modules-VHMJYYWQ.js} +1 -1
  9. package/dist/bundle/cli-runtime.js +1 -1
  10. package/dist/bundle/index.js +1 -1
  11. package/dist/bundle/rpc-entry.js +1 -1
  12. package/dist/cli/args.d.ts.map +1 -1
  13. package/dist/cli/args.js +14 -4
  14. package/dist/cli/args.js.map +1 -1
  15. package/dist/core/compaction/compaction.d.ts.map +1 -1
  16. package/dist/core/compaction/compaction.js +9 -9
  17. package/dist/core/compaction/compaction.js.map +1 -1
  18. package/dist/core/model-resolver.d.ts.map +1 -1
  19. package/dist/core/model-resolver.js +1 -1
  20. package/dist/core/model-resolver.js.map +1 -1
  21. package/docs/cli-integration.md +106 -0
  22. package/docs/cli.md +268 -0
  23. package/docs/compaction.md +22 -22
  24. package/docs/configuration.md +45 -0
  25. package/docs/containerization.md +109 -82
  26. package/docs/custom-provider.md +132 -784
  27. package/docs/docs.json +139 -99
  28. package/docs/environment-variables.md +3 -5
  29. package/docs/extensions.md +134 -3020
  30. package/docs/how-pi-works.md +49 -0
  31. package/docs/images/interactive-mode.png +0 -0
  32. package/docs/index.md +24 -69
  33. package/docs/json.md +193 -65
  34. package/docs/keybindings.md +57 -102
  35. package/docs/llama-cpp.md +3 -3
  36. package/docs/message-types.md +261 -0
  37. package/docs/models.md +55 -565
  38. package/docs/packages.md +66 -167
  39. package/docs/prompt-templates.md +31 -68
  40. package/docs/providers.md +102 -240
  41. package/docs/quickstart.md +61 -106
  42. package/docs/rpc-commands.md +854 -0
  43. package/docs/rpc-extension-ui.md +200 -0
  44. package/docs/rpc.md +129 -1556
  45. package/docs/sdk.md +76 -1171
  46. package/docs/security.md +70 -32
  47. package/docs/session-format.md +10 -214
  48. package/docs/sessions.md +35 -141
  49. package/docs/settings.md +109 -387
  50. package/docs/shell-aliases.md +85 -5
  51. package/docs/skills.md +51 -190
  52. package/docs/slash-commands.md +60 -0
  53. package/docs/terminal-setup.md +105 -78
  54. package/docs/termux.md +74 -83
  55. package/docs/themes.md +68 -280
  56. package/docs/tmux.md +31 -39
  57. package/docs/tui.md +69 -923
  58. package/docs/usage.md +54 -272
  59. package/docs/windows.md +43 -17
  60. package/examples/README.md +13 -2
  61. package/examples/extensions/custom-provider-anthropic/package-lock.json +2 -2
  62. package/examples/extensions/custom-provider-anthropic/package.json +1 -1
  63. package/examples/extensions/custom-provider-gitlab-duo/package.json +1 -1
  64. package/examples/extensions/gondolin/package-lock.json +2 -2
  65. package/examples/extensions/gondolin/package.json +1 -1
  66. package/examples/extensions/sandbox/package-lock.json +2 -2
  67. package/examples/extensions/sandbox/package.json +1 -1
  68. package/examples/extensions/with-deps/package-lock.json +2 -2
  69. package/examples/extensions/with-deps/package.json +1 -1
  70. package/examples/rpc-client.ts +35 -0
  71. package/examples/rpc-extension-ui.ts +25 -5
  72. package/examples/sdk/README.md +1 -1
  73. package/npm-shrinkwrap.json +20 -20
  74. package/package.json +8 -8
  75. package/docs/development.md +0 -90
package/docs/docs.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "navigation": [
3
3
  {
4
- "title": "Start here",
4
+ "title": "Get Started",
5
5
  "items": [
6
6
  {
7
7
  "title": "Overview",
@@ -12,142 +12,178 @@
12
12
  "path": "quickstart.md"
13
13
  },
14
14
  {
15
- "title": "Using Pi",
16
- "path": "usage.md"
17
- },
18
- {
19
- "title": "Providers",
20
- "path": "providers.md"
21
- },
22
- {
23
- "title": "Security",
24
- "path": "security.md"
25
- },
26
- {
27
- "title": "Containerization",
28
- "path": "containerization.md"
29
- },
30
- {
31
- "title": "Settings",
32
- "path": "settings.md"
33
- },
34
- {
35
- "title": "Keybindings",
36
- "path": "keybindings.md"
37
- },
38
- {
39
- "title": "Sessions",
40
- "path": "sessions.md"
41
- },
42
- {
43
- "title": "Compaction",
44
- "path": "compaction.md"
15
+ "title": "How Pi Works",
16
+ "path": "how-pi-works.md"
45
17
  }
46
18
  ]
47
19
  },
48
20
  {
49
- "title": "Customization",
21
+ "title": "Guides",
50
22
  "items": [
51
23
  {
52
- "title": "Extensions",
53
- "path": "extensions.md"
54
- },
24
+ "title": "Run Pi",
25
+ "items": [
26
+ {
27
+ "title": "Use Pi in the Terminal",
28
+ "path": "usage.md"
29
+ },
30
+ {
31
+ "title": "Choose a Model",
32
+ "path": "models.md"
33
+ },
34
+ {
35
+ "title": "Manage Sessions and Context",
36
+ "path": "sessions.md"
37
+ },
38
+ {
39
+ "title": "Run Pi Safely",
40
+ "path": "security.md"
41
+ },
42
+ {
43
+ "title": "Isolate Pi",
44
+ "path": "containerization.md"
45
+ },
46
+ {
47
+ "title": "Run Local Models",
48
+ "path": "llama-cpp.md"
49
+ },
50
+ {
51
+ "title": "Configure Your Terminal",
52
+ "path": "terminal-setup.md"
53
+ },
54
+ {
55
+ "title": "Configure Shell Commands",
56
+ "path": "shell-aliases.md"
57
+ },
58
+ {
59
+ "title": "Run Pi in tmux",
60
+ "path": "tmux.md"
61
+ },
62
+ {
63
+ "title": "Run Pi on Windows",
64
+ "path": "windows.md"
65
+ },
66
+ {
67
+ "title": "Run Pi on Android",
68
+ "path": "termux.md"
69
+ }
70
+ ]
71
+ },
72
+ {
73
+ "title": "Customize Pi",
74
+ "items": [
75
+ {
76
+ "title": "Configure Pi",
77
+ "path": "configuration.md"
78
+ },
79
+ {
80
+ "title": "Create Prompt Templates",
81
+ "path": "prompt-templates.md"
82
+ },
83
+ {
84
+ "title": "Add Skills",
85
+ "path": "skills.md"
86
+ },
87
+ {
88
+ "title": "Create Themes",
89
+ "path": "themes.md"
90
+ },
91
+ {
92
+ "title": "Use Pi Packages",
93
+ "path": "packages.md"
94
+ }
95
+ ]
96
+ },
97
+ {
98
+ "title": "Build on Pi",
99
+ "items": [
100
+ {
101
+ "title": "Build Extensions",
102
+ "path": "extensions.md"
103
+ },
104
+ {
105
+ "title": "Add Custom Providers",
106
+ "path": "custom-provider.md"
107
+ },
108
+ {
109
+ "title": "Build Terminal UI Components",
110
+ "path": "tui.md"
111
+ },
112
+ {
113
+ "title": "Integrate with the CLI",
114
+ "path": "cli-integration.md"
115
+ },
116
+ {
117
+ "title": "Use the SDK",
118
+ "path": "sdk.md"
119
+ }
120
+ ]
121
+ }
122
+ ]
123
+ },
124
+ {
125
+ "title": "Reference",
126
+ "items": [
55
127
  {
56
- "title": "Skills",
57
- "path": "skills.md"
128
+ "title": "CLI",
129
+ "path": "cli.md"
58
130
  },
59
131
  {
60
- "title": "Prompt Templates",
61
- "path": "prompt-templates.md"
132
+ "title": "Slash Commands",
133
+ "path": "slash-commands.md"
62
134
  },
63
135
  {
64
- "title": "Themes",
65
- "path": "themes.md"
136
+ "title": "Settings",
137
+ "path": "settings.md"
66
138
  },
67
139
  {
68
- "title": "Pi Packages",
69
- "path": "packages.md"
140
+ "title": "Environment Variables",
141
+ "path": "environment-variables.md"
70
142
  },
71
143
  {
72
- "title": "Custom Models",
73
- "path": "models.md"
144
+ "title": "Keybindings",
145
+ "path": "keybindings.md"
74
146
  },
75
147
  {
76
- "title": "Custom Providers",
77
- "path": "custom-provider.md"
78
- }
79
- ]
80
- },
81
- {
82
- "title": "Reference",
83
- "items": [
84
- {
85
- "title": "Environment Variables",
86
- "path": "environment-variables.md"
148
+ "title": "Provider Authentication",
149
+ "path": "providers.md"
87
150
  },
88
151
  {
89
- "title": "Session Format",
152
+ "title": "Session File Format",
90
153
  "path": "session-format.md"
91
- }
92
- ]
93
- },
94
- {
95
- "title": "Programmatic Usage",
96
- "items": [
97
- {
98
- "title": "SDK",
99
- "path": "sdk.md"
100
154
  },
101
155
  {
102
- "title": "RPC Mode",
103
- "path": "rpc.md"
156
+ "title": "Compaction and Branch Summaries",
157
+ "path": "compaction.md"
104
158
  },
105
159
  {
106
- "title": "JSON Event Stream Mode",
160
+ "title": "JSON Event Stream",
107
161
  "path": "json.md"
108
162
  },
109
163
  {
110
- "title": "TUI Components",
111
- "path": "tui.md"
112
- }
113
- ]
114
- },
115
- {
116
- "title": "Platform Setup",
117
- "items": [
118
- {
119
- "title": "Windows",
120
- "path": "windows.md"
121
- },
122
- {
123
- "title": "Termux on Android",
124
- "path": "termux.md"
164
+ "title": "RPC Protocol",
165
+ "path": "rpc.md"
125
166
  },
126
167
  {
127
- "title": "tmux",
128
- "path": "tmux.md"
168
+ "title": "RPC Commands",
169
+ "path": "rpc-commands.md"
129
170
  },
130
171
  {
131
- "title": "Terminal Setup",
132
- "path": "terminal-setup.md"
172
+ "title": "RPC Extension UI",
173
+ "path": "rpc-extension-ui.md"
133
174
  },
134
175
  {
135
- "title": "Shell Aliases",
136
- "path": "shell-aliases.md"
137
- }
138
- ]
139
- },
140
- {
141
- "title": "Development",
142
- "items": [
143
- {
144
- "title": "Development",
145
- "path": "development.md"
176
+ "title": "Message Types",
177
+ "path": "message-types.md"
146
178
  }
147
179
  ]
148
180
  }
149
181
  ],
150
182
  "redirects": [
183
+ {
184
+ "from": "development.md",
185
+ "to": "index.md"
186
+ },
151
187
  {
152
188
  "from": "session.md",
153
189
  "to": "session-format.md"
@@ -155,6 +191,10 @@
155
191
  {
156
192
  "from": "tree.md",
157
193
  "to": "sessions.md"
194
+ },
195
+ {
196
+ "from": "process-integration.md",
197
+ "to": "cli-integration.md"
158
198
  }
159
199
  ]
160
200
  }
@@ -6,7 +6,7 @@ Pi uses environment variables in three ways:
6
6
  - Pi sets process markers so child processes can identify Pi as the launching agent.
7
7
  - Commands run by the LLM-callable shell tools receive `PI_*` variables describing the current session.
8
8
 
9
- Provider API-key variables are documented separately in [Providers](providers.md#environment-variables-or-auth-file).
9
+ Provider API-key variables are documented separately in [Provider Authentication](providers.md#use-an-api-key-from-the-environment).
10
10
 
11
11
  ## Process Marker
12
12
 
@@ -81,7 +81,7 @@ These variables are read by Pi itself:
81
81
  | `PI_CODING_AGENT_DIR` | Override the config directory; default is `~/.pi/agent` |
82
82
  | `PI_CODING_AGENT_SESSION_DIR` | Override session storage; overridden by `--session-dir` |
83
83
  | `PI_PACKAGE_DIR` | Override the package directory, useful for Nix/Guix store paths |
84
- | `PI_OFFLINE` | Disable startup network operations, including update checks, package updates, and install/update telemetry |
84
+ | `PI_OFFLINE` | Disable automatic network activity, including model catalog refreshes |
85
85
  | `PI_SKIP_VERSION_CHECK` | Disable the `pi.dev` latest-version request |
86
86
  | `PI_TELEMETRY` | Override install/update telemetry and provider attribution headers: `1`/`true`/`yes` or `0`/`false`/`no` |
87
87
  | `PI_CACHE_RETENTION` | Set to `long` for extended provider prompt caching where supported |
@@ -95,6 +95,4 @@ These variables are read by Pi itself:
95
95
  | `VISUAL`, `EDITOR` | External editor fallback when `externalEditor` is unset |
96
96
  | `HTTP_PROXY`, `HTTPS_PROXY` | Proxy outbound HTTP requests |
97
97
 
98
- Provider credentials such as `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, and cloud-provider configuration are listed in [Providers](providers.md#environment-variables-or-auth-file).
99
-
100
- `PI_SERVER_DIR` and `PI_SERVER_ID` apply only to the source-only [experimental remote harness](development.md#experimental-remote-harness), not distributed builds.
98
+ Provider credentials such as `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, and cloud-provider configuration are listed in [Provider Authentication](providers.md#use-an-api-key-from-the-environment).