faux-studio 0.3.0
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 +72 -0
- package/dist/index.js +25574 -0
- package/package.json +44 -0
package/README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# faux-studio
|
|
2
|
+
|
|
3
|
+
Local MCP server that connects AI clients to Figma Desktop. Design with natural language — create components, manage tokens, and build production-quality layouts.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
npx faux-studio
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
On first run, a browser window opens for Figma OAuth. After authentication, the server starts and your AI client can call Figma tools.
|
|
12
|
+
|
|
13
|
+
## Configure Your AI Client
|
|
14
|
+
|
|
15
|
+
### Claude Code
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"mcpServers": {
|
|
20
|
+
"faux-studio": {
|
|
21
|
+
"command": "npx",
|
|
22
|
+
"args": ["-y", "faux-studio"]
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Cursor / Windsurf
|
|
29
|
+
|
|
30
|
+
Add to your MCP settings:
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
{
|
|
34
|
+
"mcpServers": {
|
|
35
|
+
"faux-studio": {
|
|
36
|
+
"command": "npx",
|
|
37
|
+
"args": ["-y", "faux-studio"]
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## How It Works
|
|
44
|
+
|
|
45
|
+
faux-studio runs locally and bridges your AI client to Figma Desktop:
|
|
46
|
+
|
|
47
|
+
1. **AI client** sends MCP tool calls (e.g., `create_component`, `set_variable`)
|
|
48
|
+
2. **faux-studio** generates Figma Plugin API scripts via the Faux cloud
|
|
49
|
+
3. Scripts execute in Figma via CDP (Chrome DevTools Protocol) or the Faux plugin
|
|
50
|
+
|
|
51
|
+
## Requirements
|
|
52
|
+
|
|
53
|
+
- Node.js 18+
|
|
54
|
+
- Figma Desktop (running)
|
|
55
|
+
- Faux account (created on first auth)
|
|
56
|
+
|
|
57
|
+
## Environment Variables
|
|
58
|
+
|
|
59
|
+
| Variable | Description |
|
|
60
|
+
|----------|-------------|
|
|
61
|
+
| `FAUX_API_KEY` | Skip OAuth — use an API key instead |
|
|
62
|
+
| `FAUX_TRANSPORT` | Force transport: `cdp` or `plugin` |
|
|
63
|
+
|
|
64
|
+
## Links
|
|
65
|
+
|
|
66
|
+
- Website: [faux.design](https://faux.design)
|
|
67
|
+
- Setup guide: [faux.design/docs/setup](https://faux.design/docs/setup)
|
|
68
|
+
- Issues: [github.com/uxfreak/faux-studio/issues](https://github.com/uxfreak/faux-studio/issues)
|
|
69
|
+
|
|
70
|
+
## License
|
|
71
|
+
|
|
72
|
+
MIT
|