agentic-numerical-control 0.1.6 → 0.2.0

package/README.md

@@ -1,44 +1,45 @@
-# Agentic Numerical Control
-
-See and run CNC jobs from Claude: a 3D toolpath viewer inside the chat, live machine status and job control, for CNCjs/GRBL machines. Claude on the web, desktop and phone.
-
-The product name, npm package name and cloud address live in [product.json](product.json); renaming is a change there.
-
-## How it fits together
-
-```
-Claude ──MCP+OAuth──▶ cloud/ (Cloudflare Worker) ◀──outbound WebSocket── PC app (npm package) ──▶ CNCjs ──USB──▶ GRBL
-```
-
-- **cloud/**: the address Claude connects to. Sign-in through Neon Auth, OAuth for Claude, PC pairing by code, and a per-user relay (Durable Object). Also serves the product page and the one-line installers. Deployed by hand: `cd cloud && npm run deploy`.
-- **PC app** (repo root, published to npm): runs beside the machine, bundles CNCjs, serves the MCP tools and the viewer, and keeps an outbound connection to the cloud. Nothing listens on the network.
-- **sim/**: grblHAL simulator exposed to CNCjs as a GRBL-SIM serial port, for testing without a machine (development only, not shipped).
-
-## For users
-
-```powershell
-irm https://agenticnumericalcontrol.netlify.app/install.ps1 | iex      # Windows
-```
-```bash
-curl -fsSL https://agenticnumericalcontrol.netlify.app/install.sh | sh # macOS / Linux
-```
-
-The installer puts a private Node.js and the app in the user's app-data folder (no admin), links the PC to the account with a code, and starts it at every login. G-code goes in `Documents/Agentic Numerical Control`. The app updates itself from npm when it starts.
-
-CLI: `anc setup | start | status | unlink | stdio | serve`.
-
-## Development
-
-```powershell
-npm install
-npm run build          # viewer + compiled app in dist/
-npm run dev            # build and run the app against the cloud in product.json
-npm run dev:serve      # local MCP endpoint only, http://127.0.0.1:3311/mcp/<token>
-npm run sim:build      # build the simulator (WSL on Windows)
-npm run sim:e2e        # connect GRBL-SIM, load the demo job, start, pause, stop
-npm pack               # what would be published (dist, product.json, demo job, sim hook)
-```
-
-State (local token, bundled CNCjs config, device link, log) is in `%LOCALAPPDATA%\AgenticNumericalControl`, `~/Library/Application Support/AgenticNumericalControl` or `~/.local/share/agentic-numerical-control`.
-
-Design notes and decisions: [docs/design-notes.md](docs/design-notes.md).
+# Agentic Numerical Control
+
+See and run CNC jobs from Claude: a 3D toolpath viewer inside the chat, live machine status and job control, for GRBL machines (and the others CNCjs supports). Claude on the web, desktop and phone.
+
+The product name, npm package name and cloud address live in [product.json](product.json); renaming is a change there.
+
+## How it fits together
+
+```
+Claude ──MCP+OAuth──▶ cloud/ (Cloudflare Worker) ◀──outbound WebSocket── PC app (npm package) ──▶ built-in CNCjs ──USB──▶ GRBL
+```
+
+- **cloud/**: the address Claude connects to. Sign-in through Neon Auth, OAuth for Claude, PC pairing by code, and a per-user relay (Durable Object). Also serves the product page and the one-line installers. Deployed by hand: `cd cloud && npm run deploy`.
+- **PC app** (repo root, published to npm): runs beside the machine, runs its own headless CNCjs engine, turns STL models into G-code with Kiri:Moto, serves the MCP tools and the viewer, and keeps an outbound connection to the cloud. Nothing listens on the network.
+- **engines/**: the headless CNCjs engine and the Kiri:Moto CAM engine, each built from a pinned, unmodified upstream commit into `dist/engines/` (see [engines/README.md](engines/README.md)).
+- **sim/**: grblHAL simulator exposed to CNCjs as a GRBL-SIM serial port, for testing without a machine (development only, not shipped).
+
+## For users
+
+```powershell
+irm https://agenticnumericalcontrol.netlify.app/install.ps1 | iex      # Windows
+```
+```bash
+curl -fsSL https://agenticnumericalcontrol.netlify.app/install.sh | sh # macOS / Linux
+```
+
+The installer puts a private Node.js and the app in the user's app-data folder (no admin), links the PC to the account with a code, and starts it at every login. G-code goes in `Documents/Agentic Numerical Control`. The app updates itself from npm when it starts.
+
+CLI: `anc setup | start | status | unlink | stdio | serve`.
+
+## Development
+
+```powershell
+npm install
+npm run build          # CNCjs and Kiri:Moto engines, viewer and compiled app in dist/
+npm run dev            # build and run the app against the cloud in product.json
+npm run dev:serve      # local MCP endpoint only, http://127.0.0.1:3311/mcp/<token>
+npm run sim:build      # build the simulator (WSL on Windows)
+npm run sim:e2e        # connect GRBL-SIM, load the demo job, start, pause, stop
+npm pack               # what would be published (dist, product.json, demo job, sim hook)
+```
+
+State (local token, CNCjs engine config, device link, log) is in `%LOCALAPPDATA%\AgenticNumericalControl`, `~/Library/Application Support/AgenticNumericalControl` or `~/.local/share/agentic-numerical-control`.
+
+Design notes and decisions: [docs/design-notes.md](docs/design-notes.md). Importing tools from other CNC software: [docs/importing-settings.md](docs/importing-settings.md).