codecaine-cli 0.0.0-stage → 0.1.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 CHANGED
@@ -1,3 +1,40 @@
1
- # Temporary Holding Version
1
+ # codecaine-cli
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
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
+ ## Your coding agent
18
+
19
+ ```bash
20
+ claude mcp add codecaine -- npx -y codecaine-cli mcp
21
+ ```
22
+
23
+ `codecaine mcp` is an MCP server on stdio. It starts the companion if it isn't
24
+ running and forwards to it, so every agent shares one companion. Ask your agent
25
+ to run the project and open it in Codecaine. It starts the dev server and calls
26
+ `openProject`, then edits the design with the editor's own tools.
27
+
28
+ HTTP clients can use `http://127.0.0.1:4317/mcp` with the bearer token the
29
+ companion prints.
30
+
31
+ ## Options
32
+
33
+ | | |
34
+ | --- | --- |
35
+ | `--editor <url>` | The editor's address (default `https://editor.codecainehq.com`) |
36
+ | `--origin <a,b>` | More origins allowed to connect |
37
+ | `--port <n>` | Default 4317 |
38
+ | `--no-open` | Don't open the browser |
39
+
40
+ State lives in `~/.codecaine/web` (`CODECAINE_HOME` to move it).