codecaine-cli 0.0.0-stage → 0.1.2
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 +51 -2
- package/dist/canvas-live-guest.js +14850 -0
- package/dist/cli.mjs +13522 -0
- package/dist/resources/bb-plugin/package.json +22 -0
- package/dist/resources/bb-plugin/src/server.ts +1084 -0
- package/dist/resources/bb-plugin/src/snapshot.ts +74 -0
- package/dist/resources/bb-plugin/src/tools.ts +830 -0
- package/package.json +34 -4
package/README.md
CHANGED
|
@@ -1,3 +1,52 @@
|
|
|
1
|
-
#
|
|
1
|
+
# codecaine-cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Connects the [Codecaine](https://editor.codecainehq.com) web editor to your
|
|
4
|
+
machine.
|
|
5
|
+
|
|
6
|
+
```bash
|
|
7
|
+
npx codecaine-cli # start it; opens the editor
|
|
8
|
+
npx codecaine-cli ./my-app # and open a project folder
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
While it runs, the editor in your browser can open and save project folders,
|
|
12
|
+
keep pictures on disk, and frame your running app on the board through a local
|
|
13
|
+
proxy, with no changes to the app. Everything stays on your machine. The
|
|
14
|
+
companion listens on `127.0.0.1` only, and only the editor's own origin can
|
|
15
|
+
connect to it.
|
|
16
|
+
|
|
17
|
+
## Setting everything up
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx codecaine-cli setup
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Starts the companion in the background, downloads and starts its assistant
|
|
24
|
+
(bb, its own copy, separate from the Codecaine desktop app's), adds the MCP
|
|
25
|
+
server to Claude Code when it is installed (`--no-mcp` skips that), and opens
|
|
26
|
+
the editor. Safe to run again.
|
|
27
|
+
|
|
28
|
+
## Your coding agent
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
claude mcp add codecaine -- npx -y codecaine-cli mcp
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
`codecaine mcp` is an MCP server on stdio. It starts the companion if it isn't
|
|
35
|
+
running and forwards to it, so every agent shares one companion. Ask your agent
|
|
36
|
+
to run the project and open it in Codecaine. It starts the dev server and calls
|
|
37
|
+
`openProject`, then edits the design with the editor's own tools.
|
|
38
|
+
|
|
39
|
+
HTTP clients can use `http://127.0.0.1:4317/mcp` with the bearer token the
|
|
40
|
+
companion prints.
|
|
41
|
+
|
|
42
|
+
## Options
|
|
43
|
+
|
|
44
|
+
| | |
|
|
45
|
+
| --- | --- |
|
|
46
|
+
| `--editor <url>` | The editor's address (default `https://editor.codecainehq.com`) |
|
|
47
|
+
| `--origin <a,b>` | More origins allowed to connect |
|
|
48
|
+
| `--port <n>` | Default 4317 |
|
|
49
|
+
| `--no-open` | Don't open the browser |
|
|
50
|
+
| `--no-assistant` | Run without the assistant (bb); board requests go to MCP agents |
|
|
51
|
+
|
|
52
|
+
State lives in `~/.codecaine/web` (`CODECAINE_HOME` to move it).
|