foundry-design-protocol 0.2.0-beta.8 → 0.2.0-beta.9
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.md +15 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ Foundry is a local-first precision design workbench for Codex, Cursor, and Claud
|
|
|
6
6
|
|
|
7
7
|
Foundry is distributed through npm, so testers do not need GitHub access.
|
|
8
8
|
|
|
9
|
-
> **Current public beta:** `0.2.0-beta.
|
|
9
|
+
> **Current public beta:** `0.2.0-beta.9`. Both npm `latest` and `beta` point to the same tested release. Use the unqualified command below for normal installation.
|
|
10
10
|
|
|
11
11
|
Full documentation is available at [withfoundry.ai](https://withfoundry.ai).
|
|
12
12
|
|
|
@@ -15,10 +15,10 @@ Full documentation is available at [withfoundry.ai](https://withfoundry.ai).
|
|
|
15
15
|
Open a terminal in the project, or ask Codex, Cursor, or Claude Code to run:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
|
-
npx foundry-design
|
|
18
|
+
npx foundry-design
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
That command detects the project and active coding agent, installs or safely updates Foundry, repairs the shared agent connection, validates its integration, starts the project when needed, and opens the visual session. On the first installation only, restart the coding agent once so it can load the shared MCP connection. A reviewed batch can be queued before the restart and will be claimed when the agent reconnects.
|
|
21
|
+
That command detects the project and active coding agent, installs or safely updates Foundry, repairs the shared agent connection, validates its integration, starts the project when needed, and opens the visual session. Before changing local configuration, Foundry prints the exact CLI and MCP bridge versions it will use. On the first installation only, restart the coding agent once so it can load the shared MCP connection. A reviewed batch can be queued before the restart and will be claimed when the agent reconnects.
|
|
22
22
|
|
|
23
23
|
After the restart, reopen the same project folder and ask:
|
|
24
24
|
|
|
@@ -33,13 +33,13 @@ That is the normal workflow. Foundry resumes the most recent session for the cur
|
|
|
33
33
|
From the first project you want to inspect, run:
|
|
34
34
|
|
|
35
35
|
```bash
|
|
36
|
-
npx foundry-design
|
|
36
|
+
npx foundry-design setup --global
|
|
37
37
|
```
|
|
38
38
|
|
|
39
39
|
For later projects, keep the shared agent connection and install only the development adapter:
|
|
40
40
|
|
|
41
41
|
```bash
|
|
42
|
-
npx foundry-design
|
|
42
|
+
npx foundry-design setup --agent none
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
Then restart the coding agent, reopen the same project folder, and ask:
|
|
@@ -48,12 +48,12 @@ Then restart the coding agent, reopen the same project folder, and ask:
|
|
|
48
48
|
Start Foundry for this project and keep listening for Apply with agent requests.
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
You do not need to run a second terminal command when the agent starts Foundry for you. Apply requests remain queued safely when the agent is offline. Run `npx foundry-design
|
|
51
|
+
You do not need to run a second terminal command when the agent starts Foundry for you. Apply requests remain queued safely when the agent is offline. Run `npx foundry-design doctor --repair` if the connection or generated integration needs repair.
|
|
52
52
|
|
|
53
53
|
Update an existing installation with:
|
|
54
54
|
|
|
55
55
|
```bash
|
|
56
|
-
npx foundry-design
|
|
56
|
+
npx foundry-design update
|
|
57
57
|
```
|
|
58
58
|
|
|
59
59
|
The updater refreshes checksum-matched Foundry files, agent connections, and skill bundles. It preserves and reports files changed since setup, validates the project, and rolls back the update if Foundry introduces a TypeScript or lint failure. Restart the coding agent after updating.
|
|
@@ -61,13 +61,20 @@ The updater refreshes checksum-matched Foundry files, agent connections, and ski
|
|
|
61
61
|
Remove only Foundry-managed integration with:
|
|
62
62
|
|
|
63
63
|
```bash
|
|
64
|
-
npx foundry-design
|
|
64
|
+
npx foundry-design uninstall
|
|
65
65
|
```
|
|
66
66
|
|
|
67
67
|
Supported automatic web integration currently includes Next.js App Router, Vite, and plain HTML. Generic web, SwiftUI, and React Native projects receive explicit setup guidance when a safe automatic edit is not available.
|
|
68
68
|
|
|
69
69
|
The npm setup above is the public beta installation path and includes the same portable skill and MCP connection used by the agent plugin bundle.
|
|
70
70
|
|
|
71
|
+
If an npm mirror or existing `npx` cache reports an old tag, bypass it with a temporary cache and the exact current release:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
FOUNDRY_NPX_CACHE="$(mktemp -d)"
|
|
75
|
+
npx --yes --prefer-online --registry=https://registry.npmjs.org --cache "$FOUNDRY_NPX_CACHE" --package=foundry-design@0.2.0-beta.9 foundry-design
|
|
76
|
+
```
|
|
77
|
+
|
|
71
78
|
The beta supports Node.js 20 or newer. Read the [local-first safety model](https://withfoundry.ai/#safety) before using it with sensitive work.
|
|
72
79
|
|
|
73
80
|
## Agent plugin
|