patchwork-os 0.2.0-beta.9.canary.86 → 0.2.0-beta.9.canary.89
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.
- package/README.bridge.md +9 -9
- package/README.md +31 -80
- package/deploy/README.md +1 -1
- package/package.json +1 -1
package/README.bridge.md
CHANGED
|
@@ -21,11 +21,11 @@ https://github.com/user-attachments/assets/a81a8d11-2cc3-46f3-88ad-6a905a221a2c
|
|
|
21
21
|
|
|
22
22
|
## Quick Start
|
|
23
23
|
|
|
24
|
-
**Prerequisites:** [Claude Code CLI](https://claude.ai/code), Node.js ≥
|
|
24
|
+
**Prerequisites:** [Claude Code CLI](https://claude.ai/code), Node.js ≥ 22
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
27
|
# 1. Install the bridge
|
|
28
|
-
npm install -g
|
|
28
|
+
npm install -g patchwork-os
|
|
29
29
|
|
|
30
30
|
# 2. One-command setup (installs extension, writes CLAUDE.md, registers MCP server)
|
|
31
31
|
cd /your/project
|
|
@@ -38,7 +38,7 @@ claude-ide-bridge --watch
|
|
|
38
38
|
claude --ide
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
> **Updating?** Use `npm install -g
|
|
41
|
+
> **Updating?** Use `npm install -g patchwork-os@latest` — `npm update -g` may lag the registry cache after a new release.
|
|
42
42
|
|
|
43
43
|
> **macOS LaunchAgent users:** always install from the registry (`npm install -g patchwork-os`) or
|
|
44
44
|
> from a tarball (`npm pack && npm install -g patchwork-os-*.tgz`).
|
|
@@ -81,7 +81,7 @@ Or search **Claude IDE Bridge** in the VS Code / Cursor / Windsurf marketplace.
|
|
|
81
81
|
|
|
82
82
|
## Slim vs Full Mode
|
|
83
83
|
|
|
84
|
-
The bridge starts in **full mode** by default (changed in v2.43.0) — all
|
|
84
|
+
The bridge starts in **full mode** by default (changed in v2.43.0) — all 177 tools, covering LSP/debugger/refactoring plus git, GitHub, terminal, file tree, and orchestration.
|
|
85
85
|
|
|
86
86
|
Pass `--slim` to restrict to the ~60 IDE-exclusive tools (LSP, debugger, editor state only) — useful when you want Claude to use its native Read/Write/Bash tools for everything else:
|
|
87
87
|
|
|
@@ -144,7 +144,7 @@ Claude calls `refactorAnalyze` (checks blast radius and risk), `refactorPreview`
|
|
|
144
144
|
Standard setup. Extension connects automatically. Full LSP, debugger, and editor state available.
|
|
145
145
|
|
|
146
146
|
### Remote SSH
|
|
147
|
-
VS Code Remote-SSH and Cursor SSH load the extension on the VPS side (`extensionKind: ["workspace"]`). Start the bridge on the remote machine. All
|
|
147
|
+
VS Code Remote-SSH and Cursor SSH load the extension on the VPS side (`extensionKind: ["workspace"]`). Start the bridge on the remote machine. All 177 tools work over SSH.
|
|
148
148
|
|
|
149
149
|
```bash
|
|
150
150
|
# On the remote machine
|
|
@@ -274,7 +274,7 @@ claude-ide-bridge install claude-mem
|
|
|
274
274
|
|---|---|
|
|
275
275
|
| `claude-ide-bridge init` | One-command setup: install extension + write CLAUDE.md + register MCP server |
|
|
276
276
|
| `claude-ide-bridge --watch` | Start bridge with auto-restart on crash (2s → 30s backoff) |
|
|
277
|
-
| `claude-ide-bridge --slim` | Restrict to ~60 IDE-exclusive tools (default:
|
|
277
|
+
| `claude-ide-bridge --slim` | Restrict to ~60 IDE-exclusive tools (default: 177 full tools) |
|
|
278
278
|
| `claude-ide-bridge install-extension` | Install companion VS Code extension |
|
|
279
279
|
| `claude-ide-bridge gen-claude-md --write` | Add bridge section to existing CLAUDE.md |
|
|
280
280
|
| `claude-ide-bridge print-token` | Print auth token from active lock file |
|
|
@@ -291,7 +291,7 @@ claude-ide-bridge install claude-mem
|
|
|
291
291
|
|
|
292
292
|
| Flag | Default | Description |
|
|
293
293
|
|---|---|---|
|
|
294
|
-
| `--slim` | off | Restrict to IDE-exclusive tools (default: full,
|
|
294
|
+
| `--slim` | off | Restrict to IDE-exclusive tools (default: full, 177 tools) |
|
|
295
295
|
| `--full` | on | No-op (retained for backward compat — full is the default since v2.43.0) |
|
|
296
296
|
| `--watch` | off | Auto-restart on crash |
|
|
297
297
|
| `--bind <host>` | `127.0.0.1` | Bind address (`0.0.0.0` for remote access) |
|
|
@@ -315,7 +315,7 @@ claude-ide-bridge install claude-mem
|
|
|
315
315
|
|---|---|
|
|
316
316
|
| [ARCHITECTURE.md](ARCHITECTURE.md) | System topology, request lifecycle, component map, design decisions |
|
|
317
317
|
| [documents/platform-docs.md](documents/platform-docs.md) | Full tool reference — all 170+ tools with parameters and examples |
|
|
318
|
-
| [documents/prompts-reference.md](documents/prompts-reference.md) | All MCP prompts (
|
|
318
|
+
| [documents/prompts-reference.md](documents/prompts-reference.md) | All MCP prompts (36 prompts, 12 plugin skills, 4 subagents) |
|
|
319
319
|
| [docs/automation.md](docs/automation.md) | Automation hooks reference — all 18 events, policy schema, condition filters |
|
|
320
320
|
| [docs/troubleshooting.md](docs/troubleshooting.md) | Diagnostics, common errors, and fixes |
|
|
321
321
|
| [docs/remote-access.md](docs/remote-access.md) | VPS setup, OAuth 2.0, nginx/Caddy reverse proxy |
|
|
@@ -333,7 +333,7 @@ claude-ide-bridge install claude-mem
|
|
|
333
333
|
|
|
334
334
|
## Requirements
|
|
335
335
|
|
|
336
|
-
- **Node.js ≥
|
|
336
|
+
- **Node.js ≥ 22** (bridge)
|
|
337
337
|
- **VS Code, Cursor, or Windsurf** — optional. Headless mode covers git, terminals, GitHub, and LSP via `typescript-language-server`. Extension required for debugger, editor decorations, and live editor state.
|
|
338
338
|
- **Claude Code CLI** — for local use. Remote MCP clients (claude.ai, Codex CLI) work via Streamable HTTP transport with OAuth 2.0.
|
|
339
339
|
|
package/README.md
CHANGED
|
@@ -1,15 +1,27 @@
|
|
|
1
1
|
# Patchwork OS
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/patchwork-os)
|
|
4
|
+
[](https://github.com/Oolab-labs/patchwork-os/actions/workflows/ci.yml)
|
|
5
|
+
[](https://www.npmjs.com/package/patchwork-os)
|
|
4
6
|
[](LICENSE)
|
|
5
7
|
|
|
6
8
|
### Your personal AI runtime, local-first.
|
|
7
9
|
|
|
8
|
-
|
|
10
|
+
**You decide which model. You decide which actions need a human nod. You own the credentials, the logs, and the deployment.** Nothing phones home unless you [opt in to anonymous analytics](#telemetry).
|
|
11
|
+
|
|
12
|
+

|
|
9
13
|
|
|
10
14
|
> Patchwork OS is a local-first personal AI runtime: pluggable model providers, hot-reloadable tools, YAML recipes, a delegation policy with approval queue, and a durable trace memory — all running on your machine, all under your policy.
|
|
11
15
|
|
|
12
|
-
|
|
16
|
+
## Contents
|
|
17
|
+
|
|
18
|
+
- [Two ways to use it](#the-same-codebase-ships-two-ways-to-use-it)
|
|
19
|
+
- [Dashboard only — no editor required](#dashboard-only--no-code-editor-required)
|
|
20
|
+
- [Claude IDE Bridge — quick start](#-claude-ide-bridge--quick-start)
|
|
21
|
+
- [Windows](#windows)
|
|
22
|
+
- [Architecture](#architecture)
|
|
23
|
+
- [Telemetry](#telemetry)
|
|
24
|
+
- [Contributing & support](#support)
|
|
13
25
|
|
|
14
26
|
**Five primitives, one runtime:**
|
|
15
27
|
|
|
@@ -25,7 +37,9 @@ You decide which model. You decide which actions need a human nod. You own the c
|
|
|
25
37
|
|
|
26
38
|
---
|
|
27
39
|
|
|
28
|
-
The same codebase ships
|
|
40
|
+
## The same codebase ships two ways to use it
|
|
41
|
+
|
|
42
|
+
Pick the layer you need.
|
|
29
43
|
|
|
30
44
|
| | What you get | Install | Best for |
|
|
31
45
|
|---|---|---|---|
|
|
@@ -42,7 +56,7 @@ Same codebase. Bridge is the foundation; Patchwork OS is the optional layer on t
|
|
|
42
56
|
|
|
43
57
|
The dashboard is a standalone Next.js app that communicates with the bridge over HTTP. No editor extension required.
|
|
44
58
|
|
|
45
|
-
**Prereqs:** [Node.js
|
|
59
|
+
**Prereqs:** [Node.js 22+](https://nodejs.org) · tmux on macOS/Linux (`brew install tmux` / `apt install tmux`) — auto-detected, falls back to background mode if absent. **Windows:** natively supported — no WSL required.
|
|
46
60
|
|
|
47
61
|
```bash
|
|
48
62
|
npx patchwork-os@beta init # scaffolds ~/.patchwork and generates a dashboard login (no install needed)
|
|
@@ -61,7 +75,7 @@ Open **http://localhost:3200** — that's it. `npx patchwork-os@beta init` auto-
|
|
|
61
75
|
|
|
62
76
|
> Developers only — skip to [Dashboard Only](#dashboard-only--no-code-editor-required) above if you just want the web dashboard.
|
|
63
77
|
|
|
64
|
-
**Prerequisites:** a supported code editor — **VS Code, Cursor, Windsurf, or Google Antigravity** (or JetBrains via the [companion plugin](#jetbrains-plugin)) — plus Node.js
|
|
78
|
+
**Prerequisites:** a supported code editor — **VS Code, Cursor, Windsurf, or Google Antigravity** (or JetBrains via the [companion plugin](#jetbrains-plugin)) — plus Node.js 22+ and the [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code). The bridge's LSP, debugger, and editor-state tools run through the editor extension; without one you're limited to the headless CLI subset.
|
|
65
79
|
|
|
66
80
|
```bash
|
|
67
81
|
# 1. Install the npm package
|
|
@@ -75,11 +89,16 @@ claude-ide-bridge install-extension
|
|
|
75
89
|
claude-ide-bridge --workspace .
|
|
76
90
|
|
|
77
91
|
# 4. Connect Claude Code (in another terminal)
|
|
92
|
+
# The env var skips Claude Code's built-in IDE-detection check — the bridge
|
|
93
|
+
# manages this connection itself. Add `export CLAUDE_CODE_IDE_SKIP_VALID_CHECK=true`
|
|
94
|
+
# to your shell profile so `claude --ide` is all you need going forward.
|
|
78
95
|
CLAUDE_CODE_IDE_SKIP_VALID_CHECK=true claude --ide
|
|
79
96
|
```
|
|
80
97
|
|
|
81
98
|
Type `/ide` in Claude Code to confirm the connection. That's it — Claude now sees your diagnostics, open files, and editor state, and can call 177 tools to act on them.
|
|
82
99
|
|
|
100
|
+
> ⭐ If this saves you a config file or a debug session, drop a star — it's the only signal I get that it's helping.
|
|
101
|
+
|
|
83
102
|
**What the bridge gives Claude:**
|
|
84
103
|
|
|
85
104
|
- Diagnostics, LSP navigation (goto / references / call hierarchy), refactoring with risk analysis
|
|
@@ -126,82 +145,13 @@ Bridge-only docs: [documents/platform-docs.md](documents/platform-docs.md)
|
|
|
126
145
|
|
|
127
146
|
---
|
|
128
147
|
|
|
129
|
-
##
|
|
130
|
-
|
|
131
|
-
The bridge, VS Code extension, and full Patchwork OS orchestrator (`patchwork start`) all work natively on Windows — no WSL required. A PowerShell-native orchestrator is also available as `npm run start-all:win`. For architecture details, troubleshooting, and contribution patterns, see [docs/windows.md](docs/windows.md).
|
|
132
|
-
|
|
133
|
-
### Prerequisites
|
|
134
|
-
|
|
135
|
-
- Node.js 20+ (from [nodejs.org](https://nodejs.org))
|
|
136
|
-
- VS Code, Cursor, or Windsurf
|
|
137
|
-
- [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code)
|
|
138
|
-
- PowerShell 5.1+ (built into Windows 10/11) or PowerShell 7+ (`pwsh`)
|
|
139
|
-
|
|
140
|
-
### Bridge-only (recommended starting point)
|
|
141
|
-
|
|
142
|
-
Open **PowerShell** or **cmd.exe**:
|
|
143
|
-
|
|
144
|
-
```powershell
|
|
145
|
-
# 1. Install
|
|
146
|
-
npm install -g patchwork-os
|
|
147
|
-
|
|
148
|
-
# 2. Install the VS Code extension
|
|
149
|
-
claude-ide-bridge install-extension
|
|
150
|
-
|
|
151
|
-
# 3. Start the bridge (bash-free entry point)
|
|
152
|
-
npm run start:bridge
|
|
153
|
-
# or equivalently:
|
|
154
|
-
node "$(npm root -g)/patchwork-os/dist/index.js" --workspace .
|
|
155
|
-
|
|
156
|
-
# 4. Connect Claude Code (new terminal)
|
|
157
|
-
claude --ide
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
Type `/ide` in Claude Code to confirm the connection.
|
|
148
|
+
## Windows
|
|
161
149
|
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
Two options — both work on Windows, macOS, and Linux:
|
|
165
|
-
|
|
166
|
-
```powershell
|
|
167
|
-
# Option A: cross-platform Node.js orchestrator (recommended)
|
|
168
|
-
npm run start-all:node
|
|
169
|
-
npm run start-all:node -- --workspace C:\myproj --full --no-dashboard
|
|
170
|
-
|
|
171
|
-
# Option B: PowerShell-native orchestrator (Windows only, no Node wrapper overhead)
|
|
172
|
-
npm run start-all:win
|
|
173
|
-
npm run start-all:win -- -NoDashboard -Workspace C:\myproj -Full
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
Both start the bridge, wait for the lock file, launch `claude --ide` and `remote-control`, start the Next.js dashboard on `http://localhost:3200`, poll until it's ready, then open it in your default browser. The health monitor restarts the bridge automatically if it crashes, with exponential backoff.
|
|
177
|
-
|
|
178
|
-
```powershell
|
|
179
|
-
# Node orchestrator options (--key value form)
|
|
180
|
-
npm run start-all:node -- --full # all 177 tools
|
|
181
|
-
npm run start-all:node -- --no-dashboard # skip dashboard
|
|
182
|
-
npm run start-all:node -- --dashboard-port 3300
|
|
183
|
-
npm run start-all:node -- --no-remote # skip remote-control
|
|
184
|
-
npm run start-all:node -- --notify my-topic # ntfy.sh push notifications
|
|
185
|
-
```
|
|
186
|
-
|
|
187
|
-
### Known limitations on native Windows
|
|
188
|
-
|
|
189
|
-
| Feature | Status |
|
|
190
|
-
|---|---|
|
|
191
|
-
| Bridge + extension (LSP, debugger, editor state) | ✅ Full support |
|
|
192
|
-
| `npm run start:bridge` | ✅ Supported |
|
|
193
|
-
| `npm run start-all:node` (Node.js orchestrator) | ✅ Supported — cross-platform |
|
|
194
|
-
| `npm run start-all:win` (PS1 orchestrator) | ✅ Supported — Windows-native |
|
|
195
|
-
| Dashboard (`http://localhost:3200`) | ✅ Opens automatically |
|
|
196
|
-
| `patchwork start` / `npm run start-all` | ⚠️ Requires WSL2 or Git Bash (uses bash + tmux) |
|
|
197
|
-
| `npm run remote:node` | ✅ Supported — cross-platform Node auto-restart wrapper |
|
|
198
|
-
| `npm run remote` / `npm run vps` | ⚠️ Requires WSL2 or Git Bash |
|
|
199
|
-
| Screenshot capture (standalone bridge) | ⚠️ Not yet supported; extension screenshot works via VS Code |
|
|
200
|
-
| Credential storage | ✅ Uses DPAPI (Windows Data Protection API) via PowerShell |
|
|
150
|
+
The bridge, VS Code extension, and orchestrator all run **natively on Windows — no WSL required**. Install the same way (`npm install -g patchwork-os`), then start the bridge with `npm run start:bridge` or the full stack with `npm run start-all:node` (cross-platform) / `npm run start-all:win` (PowerShell-native).
|
|
201
151
|
|
|
202
|
-
|
|
152
|
+
A few bash+tmux entry points (`patchwork start`, `npm run remote`) still need WSL2 or Git Bash. Credential storage uses Windows DPAPI.
|
|
203
153
|
|
|
204
|
-
|
|
154
|
+
**Full setup, the orchestrator flag reference, and the native-Windows limitations table:** [docs/windows.md](docs/windows.md).
|
|
205
155
|
|
|
206
156
|
---
|
|
207
157
|
|
|
@@ -327,7 +277,7 @@ The package ships these in `templates/recipes/`. Recipes that need API keys are
|
|
|
327
277
|
|
|
328
278
|
**Delegation policy presets** ([`templates/policies/`](templates/policies/)): five persona starters — conservative, developer, headless-CI, regulated-industry, personal-assistant. Copy one into `~/.patchwork/config.json` and restart.
|
|
329
279
|
|
|
330
|
-
**Webhook recipe starters** ([`templates/recipes/webhook/`](templates/recipes/webhook/)):
|
|
280
|
+
**Webhook recipe starters** ([`templates/recipes/webhook/`](templates/recipes/webhook/)): six webhook-triggered recipes — capture-thought, morning-brief (on-demand), meeting-prep, incident-intake, customer-escalation, apple-watch-health-log. Anything that can POST HTTP can drive these — iPhone Shortcut, Stream Deck, Home Assistant, NFC tag, monitoring tool.
|
|
331
281
|
|
|
332
282
|
### Automation hooks
|
|
333
283
|
|
|
@@ -419,7 +369,7 @@ Use whichever fits your mental model.
|
|
|
419
369
|
|
|
420
370
|
| Category | Tools |
|
|
421
371
|
|---|---|
|
|
422
|
-
| LSP / Code Intelligence | `getDiagnostics`, `goToDefinition`, `findReferences`, `getCallHierarchy`, `renameSymbol`, `refactorAnalyze`, `explainSymbol`, … (
|
|
372
|
+
| LSP / Code Intelligence | `getDiagnostics`, `goToDefinition`, `findReferences`, `getCallHierarchy`, `renameSymbol`, `refactorAnalyze`, `explainSymbol`, … (34 tools) |
|
|
423
373
|
| Git | `getGitStatus`, `getGitDiff`, `gitCommit`, `gitPush`, `gitCheckout`, `gitBlame`, … (16 tools) |
|
|
424
374
|
| GitHub | `githubCreatePR`, `githubListPRs`, `githubCreateIssue`, `githubPostPRReview`, … (13 tools) |
|
|
425
375
|
| Terminal | `runInTerminal`, `createTerminal`, `getTerminalOutput`, `waitForTerminalOutput` |
|
|
@@ -558,6 +508,7 @@ Patchwork ships an **opt-in** anonymous usage summary. It is **disabled by defau
|
|
|
558
508
|
|
|
559
509
|
- **Bugs & feature requests:** [GitHub Issues](https://github.com/Oolab-labs/patchwork-os/issues)
|
|
560
510
|
- **Questions & community:** [GitHub Discussions](https://github.com/Oolab-labs/patchwork-os/discussions)
|
|
511
|
+
- **Contributing:** see [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
561
512
|
|
|
562
513
|
---
|
|
563
514
|
|
package/deploy/README.md
CHANGED
|
@@ -31,7 +31,7 @@ DOMAIN=bridge.example.com bash deploy/bootstrap-new-vps.sh
|
|
|
31
31
|
```
|
|
32
32
|
|
|
33
33
|
The bootstrap script handles everything end-to-end:
|
|
34
|
-
1. Installs Node.js
|
|
34
|
+
1. Installs Node.js 22, nginx, certbot
|
|
35
35
|
2. Creates a dedicated `claude-bridge` system user (non-root)
|
|
36
36
|
3. Clones the repo to `/opt/claude-ide-bridge`
|
|
37
37
|
4. Runs `npm ci && npm run build`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "patchwork-os",
|
|
3
|
-
"version": "0.2.0-beta.9.canary.
|
|
3
|
+
"version": "0.2.0-beta.9.canary.89",
|
|
4
4
|
"description": "Your personal AI runtime, local-first. Patchwork OS gives any AI model a consistent set of tools, YAML recipes, a delegation policy with approval queue, and a durable trace memory — all on your machine, all under your policy.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|