@kingingwang/pi-windows-x64 0.87.0 → 0.99.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 (76) hide show
  1. package/bin/CHANGELOG.md +121 -0
  2. package/bin/README.md +25 -711
  3. package/bin/docs/cli-integration.md +106 -0
  4. package/bin/docs/cli.md +329 -0
  5. package/bin/docs/compaction.md +22 -22
  6. package/bin/docs/configuration.md +47 -0
  7. package/bin/docs/containerization.md +109 -82
  8. package/bin/docs/custom-provider.md +109 -722
  9. package/bin/docs/docs.json +147 -99
  10. package/bin/docs/environment-variables.md +3 -5
  11. package/bin/docs/extensions.md +165 -2996
  12. package/bin/docs/how-pi-works.md +49 -0
  13. package/bin/docs/images/interactive-mode.png +0 -0
  14. package/bin/docs/index.md +24 -69
  15. package/bin/docs/json.md +193 -65
  16. package/bin/docs/keybindings.md +58 -103
  17. package/bin/docs/llama-cpp.md +16 -3
  18. package/bin/docs/mcp.md +188 -0
  19. package/bin/docs/message-types.md +261 -0
  20. package/bin/docs/models.md +81 -556
  21. package/bin/docs/packages.md +67 -166
  22. package/bin/docs/prompt-templates.md +31 -68
  23. package/bin/docs/providers.md +103 -240
  24. package/bin/docs/quickstart.md +61 -106
  25. package/bin/docs/rpc-commands.md +860 -0
  26. package/bin/docs/rpc-extension-ui.md +200 -0
  27. package/bin/docs/rpc.md +130 -1555
  28. package/bin/docs/sdk.md +79 -1169
  29. package/bin/docs/security.md +72 -32
  30. package/bin/docs/session-format.md +15 -215
  31. package/bin/docs/sessions.md +35 -141
  32. package/bin/docs/settings.md +117 -377
  33. package/bin/docs/shell-aliases.md +85 -5
  34. package/bin/docs/skills.md +51 -190
  35. package/bin/docs/slash-commands.md +60 -0
  36. package/bin/docs/terminal-setup.md +105 -78
  37. package/bin/docs/termux.md +74 -83
  38. package/bin/docs/themes.md +88 -274
  39. package/bin/docs/tmux.md +31 -39
  40. package/bin/docs/tui.md +74 -910
  41. package/bin/docs/usage.md +54 -272
  42. package/bin/docs/virtual-models.md +114 -0
  43. package/bin/docs/windows.md +45 -17
  44. package/bin/examples/README.md +13 -2
  45. package/bin/examples/extensions/README.md +2 -0
  46. package/bin/examples/extensions/custom-provider-anthropic/package-lock.json +2 -2
  47. package/bin/examples/extensions/custom-provider-anthropic/package.json +1 -1
  48. package/bin/examples/extensions/custom-provider-gitlab-duo/package.json +1 -1
  49. package/bin/examples/extensions/custom-provider-gitlab-duo/test.ts +5 -5
  50. package/bin/examples/extensions/debug-provider.ts +90 -0
  51. package/bin/examples/extensions/gondolin/package-lock.json +2 -2
  52. package/bin/examples/extensions/gondolin/package.json +1 -1
  53. package/bin/examples/extensions/jev-router.ts +113 -0
  54. package/bin/examples/extensions/sandbox/package-lock.json +2 -2
  55. package/bin/examples/extensions/sandbox/package.json +1 -1
  56. package/bin/examples/extensions/with-deps/package-lock.json +2 -2
  57. package/bin/examples/extensions/with-deps/package.json +1 -1
  58. package/bin/examples/rpc-client.ts +35 -0
  59. package/bin/examples/rpc-extension-ui.ts +26 -6
  60. package/bin/examples/sdk/14-codemode-mcp.ts +61 -0
  61. package/bin/examples/sdk/README.md +3 -2
  62. package/bin/export-html/ansi-to-html.d.ts.map +1 -1
  63. package/bin/export-html/ansi-to-html.js.map +1 -1
  64. package/bin/export-html/index.d.ts.map +1 -1
  65. package/bin/export-html/index.js.map +1 -1
  66. package/bin/export-html/template.css +10 -0
  67. package/bin/export-html/template.js +66 -17
  68. package/bin/export-html/tool-renderer.d.ts.map +1 -1
  69. package/bin/export-html/tool-renderer.js.map +1 -1
  70. package/bin/package.json +14 -12
  71. package/bin/pi.exe +2 -2
  72. package/bin/theme/dark.json +59 -72
  73. package/bin/theme/light.json +57 -69
  74. package/bin/theme/theme-schema.json +7 -2
  75. package/package.json +1 -1
  76. package/bin/docs/development.md +0 -90
@@ -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,186 @@
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
+ "title": "Connect MCP Servers",
97
+ "path": "mcp.md"
98
+ }
99
+ ]
100
+ },
101
+ {
102
+ "title": "Build on Pi",
103
+ "items": [
104
+ {
105
+ "title": "Build Extensions",
106
+ "path": "extensions.md"
107
+ },
108
+ {
109
+ "title": "Add Custom Providers",
110
+ "path": "custom-provider.md"
111
+ },
112
+ {
113
+ "title": "Route with Virtual Models",
114
+ "path": "virtual-models.md"
115
+ },
116
+ {
117
+ "title": "Build Terminal UI Components",
118
+ "path": "tui.md"
119
+ },
120
+ {
121
+ "title": "Integrate with the CLI",
122
+ "path": "cli-integration.md"
123
+ },
124
+ {
125
+ "title": "Use the SDK",
126
+ "path": "sdk.md"
127
+ }
128
+ ]
129
+ }
130
+ ]
131
+ },
132
+ {
133
+ "title": "Reference",
134
+ "items": [
55
135
  {
56
- "title": "Skills",
57
- "path": "skills.md"
136
+ "title": "CLI",
137
+ "path": "cli.md"
58
138
  },
59
139
  {
60
- "title": "Prompt Templates",
61
- "path": "prompt-templates.md"
140
+ "title": "Slash Commands",
141
+ "path": "slash-commands.md"
62
142
  },
63
143
  {
64
- "title": "Themes",
65
- "path": "themes.md"
144
+ "title": "Settings",
145
+ "path": "settings.md"
66
146
  },
67
147
  {
68
- "title": "Pi Packages",
69
- "path": "packages.md"
148
+ "title": "Environment Variables",
149
+ "path": "environment-variables.md"
70
150
  },
71
151
  {
72
- "title": "Custom Models",
73
- "path": "models.md"
152
+ "title": "Keybindings",
153
+ "path": "keybindings.md"
74
154
  },
75
155
  {
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"
156
+ "title": "Provider Authentication",
157
+ "path": "providers.md"
87
158
  },
88
159
  {
89
- "title": "Session Format",
160
+ "title": "Session File Format",
90
161
  "path": "session-format.md"
91
- }
92
- ]
93
- },
94
- {
95
- "title": "Programmatic Usage",
96
- "items": [
97
- {
98
- "title": "SDK",
99
- "path": "sdk.md"
100
162
  },
101
163
  {
102
- "title": "RPC Mode",
103
- "path": "rpc.md"
164
+ "title": "Compaction and Branch Summaries",
165
+ "path": "compaction.md"
104
166
  },
105
167
  {
106
- "title": "JSON Event Stream Mode",
168
+ "title": "JSON Event Stream",
107
169
  "path": "json.md"
108
170
  },
109
171
  {
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"
172
+ "title": "RPC Protocol",
173
+ "path": "rpc.md"
125
174
  },
126
175
  {
127
- "title": "tmux",
128
- "path": "tmux.md"
176
+ "title": "RPC Commands",
177
+ "path": "rpc-commands.md"
129
178
  },
130
179
  {
131
- "title": "Terminal Setup",
132
- "path": "terminal-setup.md"
180
+ "title": "RPC Extension UI",
181
+ "path": "rpc-extension-ui.md"
133
182
  },
134
183
  {
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"
184
+ "title": "Message Types",
185
+ "path": "message-types.md"
146
186
  }
147
187
  ]
148
188
  }
149
189
  ],
150
190
  "redirects": [
191
+ {
192
+ "from": "development.md",
193
+ "to": "index.md"
194
+ },
151
195
  {
152
196
  "from": "session.md",
153
197
  "to": "session-format.md"
@@ -155,6 +199,10 @@
155
199
  {
156
200
  "from": "tree.md",
157
201
  "to": "sessions.md"
202
+ },
203
+ {
204
+ "from": "process-integration.md",
205
+ "to": "cli-integration.md"
158
206
  }
159
207
  ]
160
208
  }
@@ -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).