You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit ffc9c62
Browse filesBrowse the repository at this point in the historyBrowse files
docs(readme): redesign README with real Web workbench media (#918)
* docs(readme): redesign README with real Web workbench media
- New hero (light/dark via <picture>), demo recording, feature grid,
v1.2.0 highlights, screenshot tour and architecture diagram
- Screenshots and recording are captured from the real OpenPI Web
workbench against a demo repository (scripted local provider)
- Same structure for README.zh-CN.md; reference sections unchanged,
Defaults table folded into <details>
- Media lives in docs/assets/readme/ so it is not shipped in the npm package
* chore(assets): remove README images no longer referenced
<imgsrc="assets/openpi-product-hero-v2.webp"alt="OpenPI — Build. Delegate. Keep moving. A local Web workbench, isolated subagents, and workflows for Pi."width="100%" />
<img src="docs/assets/readme/hero-dark.webp" alt="OpenPI — the Pi-native multi-agent workbench. The OpenPI Web workbench showing a parent session that delegated two isolated subagents, next to one subagent's read-only transcript." width="100%">
7
+
</picture>
8
+
</a>
3
9
</p>
4
10
11
+
<h3align="center">Stay on your problem. Let independent work run in parallel.</h3>
12
+
5
13
<palign="center">
6
-
<strong>Stay on your problem. Let independent work run in parallel.</strong><br />
7
-
OpenPI adds a local Web workbench, isolated-context subagents, and Workflows to <ahref="https://pi.dev">Pi</a>.<br />
8
-
It keeps your models, tools, and Skills — everyday coding stays light, advanced capabilities unfold when needed.
14
+
OpenPI adds isolated subagents, replay-safe Workflows and a local Web workbench to <ahref="https://pi.dev">Pi</a> —<br />
15
+
inside Pi's own sessions, providers, tools, Skills and Trust. Everyday coding stays light; power unfolds when you ask for it.
<sub>OpenPI is an independent community project, unaffiliated with Physical Intelligence's openpi robotics project and with the Pi team.</sub>
32
37
</p>
33
38
34
-
---
35
-
36
-
## What OpenPI is
39
+
<br />
37
40
38
-
Pi is deliberately small: an agent loop, tools, sessions, and an extension API. OpenPI is a capability layer that stays inside Pi's lifecycle, sessions, providers, and trust boundaries — not a second agent operating system.
39
-
40
-
-**Local Web workbench** — manage workspaces and sessions in the browser, and inspect saved prompts, tool arguments, and results. Independent of terminal sessions.
41
-
-**Subagents** — delegate self-contained work to in-process Pi sessions with isolated context; results are delivered automatically.
42
-
-**Workflows** — multi-phase, multi-agent orchestration with structured results, safe replay, and auditable artifacts.
43
-
-**Terminal experience** — a status footer, compact tool results, Plan mode, and session-scoped helpers.
44
-
-**Pi-native** — your provider, models, tools, Skills, sessions, and Trust stay in charge; OpenPI only adds capabilities at Pi's extension seams.
41
+
<palign="center">
42
+
<imgsrc="docs/assets/readme/demo-subagents.webp"alt="Recording of the OpenPI Web workbench: a prompt asks for two parallel audits, two subagents run and complete in the session overview, the parent merges their file:line findings into a prioritized table, and one subagent's transcript opens read-only."width="100%">
43
+
<br />
44
+
<sub>Real OpenPI Web workbench and real tool calls against a small demo repository. Model replies come from a scripted local provider so the recording is reproducible.</sub>
45
+
</p>
45
46
46
47
## Quick start
47
48
48
49
```bash
49
50
pi install npm:@tt-a1i/openpi
50
51
```
51
52
52
-
Restart Pi, or run `/reload` in the current session. Then describe real work:
53
-
54
-
```text
55
-
Start the dev server in the background with `nohup npm run dev &`, then keep
56
-
editing the page; check on it with ordinary process commands when needed.
57
-
```
53
+
Restart Pi, or run `/reload` in the current session. Then describe real work — the model decides how to split it:
58
54
59
55
```text
60
56
Spawn subagents to check the login flow and its tests in parallel, each with
@@ -66,15 +62,109 @@ Use a workflow to review these modules: collect issues in parallel, verify the
66
62
findings, then synthesize what to fix first.
67
63
```
68
64
69
-
The model decides how to split the work; OpenPI provides execution, status, results, and stop controls. Only genuinely independent tasks benefit from parallelism — the gain depends on the task, model, and configuration.
65
+
```text
66
+
Start the dev server in the background with `nohup npm run dev &`, then keep
67
+
editing the page; check on it with ordinary process commands when needed.
68
+
```
70
69
71
-
Prefer a browser? Type `/web` in Pi, open the local address printed in the terminal, pick a model and workspace, and start chatting. Web sessions are independent and never take over a terminal conversation. See [Web workbench](#web-workbench).
70
+
Prefer a browser? Type `/web` in Pi and open the local address printed in the terminal. Web sessions are independent and never take over a terminal conversation. Configure OpenPI itself in plain language with `/openpi-setup`.
71
+
72
+
OpenPI provides execution, status, results and stop controls. Only genuinely independent tasks benefit from parallelism — the gain depends on the task, model and configuration.
73
+
74
+
## Why OpenPI
75
+
76
+
Pi is deliberately small: an agent loop, tools, sessions and an extension API. OpenPI is a capability layer that stays inside Pi's lifecycle, sessions, providers and trust boundaries — not a second agent operating system.
77
+
78
+
<table>
79
+
<tr>
80
+
<td width="33%" valign="top">
81
+
<h4>Isolated subagents</h4>
82
+
Delegate self-contained work to in-process Pi sessions with their own context. They run concurrently and report back automatically — optionally in their own Git worktree.
83
+
</td>
84
+
<td width="33%" valign="top">
85
+
<h4>Replay-safe workflows</h4>
86
+
Script multi-phase, multi-agent runs with <code>phase</code>, <code>agent</code>, <code>parallel</code> and <code>pipeline</code>. Structured results, a journal, safe replay and auditable artifacts.
87
+
</td>
88
+
<td width="33%" valign="top">
89
+
<h4>Local Web workbench</h4>
90
+
Workspaces, sessions, changes, files and a trajectory inspector for every model and tool call — in a browser, authenticated, on your machine.
91
+
</td>
92
+
</tr>
93
+
<tr>
94
+
<td width="33%" valign="top">
95
+
<h4>Plan mode & human input</h4>
96
+
<code>/plan</code> researches read-only, then turns an explicit Plan Ready into implementation. <code>ask_user</code> and <code>human_handoff</code> collect decisions only you can make.
97
+
</td>
98
+
<td width="33%" valign="top">
99
+
<h4>Semantic navigation</h4>
100
+
A bundled Skill asks an existing local language server for definitions, references and diagnostics — on demand, never started on launch.
101
+
</td>
102
+
<td width="33%" valign="top">
103
+
<h4>Pi-native and quiet</h4>
104
+
Your provider, models, tools, Skills and Trust stay in charge. A fixed resident tool set, no theme or model changes on install, no extra model calls by default.
105
+
</td>
106
+
</tr>
107
+
</table>
108
+
109
+
### New in v1.2.0
110
+
111
+
-**Semantic navigation Skill** for definitions, references and single-file diagnostics through a local language server. ([#916](https://github.com/openpi-dev/openpi/pull/916))
112
+
-**Context composition** in the Web usage popover: system text, tool declarations and conversation of the latest call. ([#914](https://github.com/openpi-dev/openpi/pull/914))
113
+
-**Trajectory overview** with context/model/tool tracks, search and a per-call inspector, plus a refreshed workbench, themes and model picker. ([#868](https://github.com/openpi-dev/openpi/pull/868), [#894](https://github.com/openpi-dev/openpi/pull/894), [#904](https://github.com/openpi-dev/openpi/pull/904), [#865](https://github.com/openpi-dev/openpi/pull/865))
114
+
-**Quoted review and plan snippets keep their source** (repository, comparison, revision or session). ([#915](https://github.com/openpi-dev/openpi/pull/915))
115
+
-**↑/↓ prompt history** in the Web composer, and **custom thinking levels** for custom models. ([#912](https://github.com/openpi-dev/openpi/pull/912), [#864](https://github.com/openpi-dev/openpi/pull/864))
116
+
- CI now covers the **minimum and latest supported Pi hosts**. ([#719](https://github.com/openpi-dev/openpi/pull/719)) — [Full release notes](https://github.com/openpi-dev/openpi/releases/tag/v1.2.0)
117
+
118
+
## See it work
72
119
73
-
Configure OpenPI's own preferences through natural language:
<img src="docs/assets/readme/shot-subagents-dark.webp" alt="OpenPI Web workbench: the parent conversation lists two subagents and a prioritized table of findings; the right pane shows the audit-login-flow subagent's completed transcript, read-only." width="100%">
125
+
</picture>
126
+
<br />
127
+
<sub><b>Delegate, keep working, inspect.</b> The parent stays free while two isolated subagents audit code; open any child's transcript read-only.</sub>
<img src="docs/assets/readme/shot-changes-dark.webp" alt="Changes pane with a unified diff of src/auth/session.ts next to the conversation that made the edit." width="100%">
137
+
</picture>
138
+
<p align="center"><sub><b>Review every change</b><br />Working-tree diffs beside the turn that made them.</sub></p>
<img src="docs/assets/readme/shot-trajectory-dark.webp" alt="Trajectory view with context, model and tool tracks and an inspector showing the arguments and result of a subagent_spawn call." width="100%">
145
+
</picture>
146
+
<p align="center"><sub><b>Trace every call</b><br />Context, model and tool tracks with a per-call inspector.</sub></p>
<img src="docs/assets/readme/shot-context-dark.webp" alt="Session overview popover with context usage, observed system prompt, tool and conversation sizes, and session token totals." width="100%">
153
+
</picture>
154
+
<p align="center"><sub><b>Know your context</b><br />What the latest call actually sent, and session totals.</sub></p>
<img src="docs/assets/readme/architecture-light.svg" alt="Diagram: the Pi terminal and the OpenPI Web workbench each drive a parent Pi session that keeps your provider, models, tools, Skills and Trust, with a fixed resident set of five subagent and three workflow tools. The parent delegates to Pi Bash for long-running processes, to subagents, or to workflows; results flow back to the parent automatically." width="100%">
166
+
</picture>
167
+
</p>
78
168
79
169
## Light by default
80
170
@@ -227,6 +317,9 @@ Safety here is a runtime constraint, not a prompt.
227
317
228
318
### Defaults
229
319
320
+
<details>
321
+
<summary><strong>All defaults</strong> — every setting starts here; staying at defaults creates no file.</summary>
322
+
230
323
| Setting | Default |
231
324
| --- | --- |
232
325
| Code Mode (`code_mode_enabled`) | Off; opt in via `/openpi-setup` |
@@ -254,6 +347,8 @@ Safety here is a runtime constraint, not a prompt.
254
347
| Post-edit command | Off; a single command of at most 500 characters |
255
348
| Built-in role models | All inherit the parent model |
Settings → General saves the follow-up default in `ui.webFollowUpBehavior`. The composer override and Command/Ctrl+Enter change only one message. After the active turn ends, the next explicit submit starts a normal turn; the draft is never sent automatically. `/openpi-setup` edits the same preference.
0 commit comments