foundry-design-web-adapter 0.2.0-beta.12 → 0.2.0-beta.14
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 +47 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,11 +6,19 @@ 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
|
-
> **
|
|
9
|
+
> **Release candidate:** `0.2.0-beta.14`. The commands below are prepared for this release and must not be promoted to npm `latest` until the full installation matrix passes.
|
|
10
10
|
|
|
11
11
|
Full documentation is available at [withfoundry.ai](https://withfoundry.ai).
|
|
12
12
|
|
|
13
|
-
### Recommended:
|
|
13
|
+
### Recommended: install once, use in every project
|
|
14
|
+
|
|
15
|
+
Install Foundry's shared connection for Codex, Cursor, and Claude once:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx foundry-design install
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Restart the selected coding agents once. Then open any project and run:
|
|
14
22
|
|
|
15
23
|
Open a terminal in the project, or ask Codex, Cursor, or Claude Code to run:
|
|
16
24
|
|
|
@@ -18,7 +26,7 @@ Open a terminal in the project, or ask Codex, Cursor, or Claude Code to run:
|
|
|
18
26
|
npx foundry-design
|
|
19
27
|
```
|
|
20
28
|
|
|
21
|
-
That command
|
|
29
|
+
That command finds the nearest real project, detects its framework, installs or safely updates only the development adapter and lightweight project connection, validates it, starts the project when needed, and opens the visual session. The agent bridge and skill remain installed once at machine level. Foundry refuses to treat a home folder as a project and prints the exact CLI and MCP bridge versions before changing configuration.
|
|
22
30
|
|
|
23
31
|
After the restart, reopen the same project folder and ask:
|
|
24
32
|
|
|
@@ -30,16 +38,16 @@ That is the normal workflow. Foundry resumes the most recent session for the cur
|
|
|
30
38
|
|
|
31
39
|
### Manual installation
|
|
32
40
|
|
|
33
|
-
|
|
41
|
+
Install the shared connection for selected agents:
|
|
34
42
|
|
|
35
43
|
```bash
|
|
36
|
-
npx foundry-design
|
|
44
|
+
npx foundry-design install --agent codex,cursor,claude
|
|
37
45
|
```
|
|
38
46
|
|
|
39
|
-
|
|
47
|
+
Connect any project with only its development adapter and local project metadata:
|
|
40
48
|
|
|
41
49
|
```bash
|
|
42
|
-
npx foundry-design
|
|
50
|
+
npx foundry-design connect
|
|
43
51
|
```
|
|
44
52
|
|
|
45
53
|
Then restart the coding agent, reopen the same project folder, and ask:
|
|
@@ -58,13 +66,27 @@ npx foundry-design status
|
|
|
58
66
|
|
|
59
67
|
Foundry reports project integration, the exact MCP package version, runtime health, and the live agent listener separately. Run `npx foundry-design doctor --repair` if configuration or generated integration needs repair.
|
|
60
68
|
|
|
69
|
+
If an older project has stale or conflicting project-scoped agent configuration, run:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
npx foundry-design reset
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Reset migrates Foundry-owned project MCP files and skills to the shared connection, preserves customized files, and reports anything it could not replace safely.
|
|
76
|
+
|
|
61
77
|
Update an existing installation with:
|
|
62
78
|
|
|
63
79
|
```bash
|
|
64
80
|
npx foundry-design update
|
|
65
81
|
```
|
|
66
82
|
|
|
67
|
-
The updater refreshes checksum-matched
|
|
83
|
+
The updater refreshes checksum-matched project files and the shared machine connection. It removes only Foundry-owned legacy project agent files, preserves customized files, validates the project, and rolls back if Foundry introduces a TypeScript or lint failure. Restart the coding agent only when its shared bridge version changes.
|
|
84
|
+
|
|
85
|
+
Remove a project from Foundry's recent-project list without removing its adapter:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
npx foundry-design disconnect
|
|
89
|
+
```
|
|
68
90
|
|
|
69
91
|
Remove only Foundry-managed integration with:
|
|
70
92
|
|
|
@@ -72,6 +94,18 @@ Remove only Foundry-managed integration with:
|
|
|
72
94
|
npx foundry-design uninstall
|
|
73
95
|
```
|
|
74
96
|
|
|
97
|
+
Remove the shared machine connection separately:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
npx foundry-design uninstall --global
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Project-scoped MCP configuration remains available only as an explicit compatibility mode:
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
npx foundry-design setup --project-agent --agent codex
|
|
107
|
+
```
|
|
108
|
+
|
|
75
109
|
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.
|
|
76
110
|
|
|
77
111
|
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.
|
|
@@ -84,7 +118,7 @@ If an npm mirror or existing `npx` cache reports an old tag, bypass it with a te
|
|
|
84
118
|
|
|
85
119
|
```bash
|
|
86
120
|
FOUNDRY_NPX_CACHE="$(mktemp -d)"
|
|
87
|
-
npx --yes --prefer-online --registry=https://registry.npmjs.org --cache "$FOUNDRY_NPX_CACHE" --package=foundry-design@0.2.0-beta.
|
|
121
|
+
npx --yes --prefer-online --registry=https://registry.npmjs.org --cache "$FOUNDRY_NPX_CACHE" --package=foundry-design@0.2.0-beta.14 foundry-design
|
|
88
122
|
```
|
|
89
123
|
|
|
90
124
|
The beta supports Node.js 20 or newer. Read the [local-first safety model](https://withfoundry.ai/#safety) before using it with sensitive work.
|
|
@@ -99,6 +133,10 @@ Start Foundry for this project.
|
|
|
99
133
|
|
|
100
134
|
Foundry remains local-first. Installing the plugin does not create an account, enable telemetry, or send project data to a Foundry service.
|
|
101
135
|
|
|
136
|
+
### Cursor one-click connection
|
|
137
|
+
|
|
138
|
+
[Add the Foundry MCP bridge to Cursor](https://cursor.com/link/mcp/install?name=foundry-design-control&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIi0tcHJlZmVyLW9ubGluZSIsImZvdW5kcnktZGVzaWduLW1jcC1zZXJ2ZXJAMC4yLjAtYmV0YS4xNCJdfQ%3D%3D), then run `npx foundry-design` inside the project. The repository's Cursor plugin additionally bundles the Foundry skill and session-start hook for marketplace distribution.
|
|
139
|
+
|
|
102
140
|
## Current capabilities
|
|
103
141
|
|
|
104
142
|
- A dedicated local design workspace with a live product canvas, equal Layers and Inspector docks, and a direct-overlay fallback when a product blocks framing
|