Files
cadcraft/docs/control-protocol.md
T
Valentin KleinandClaude Opus 5.5 a349e4925f Command line, ViewCube and UCS icon take the pointer; history window (F2) (#181)
Clicks on the command line's history, the UCS icon and the ViewCube ring fell
through to the drawing (picking objects or starting a selection window, or
entering a point during a command), the chevron did nothing, and the wheel over
the overlays zoomed the drawing. The ViewCube's Top face was a click-only
widget, so the canvas still counted as hovered underneath it (crosshair, wheel).

- Every overlay now registers a widget that senses clicks and drags, so egui
  hands the pointer to the overlay instead of the canvas.
- Command line: a click on the history lines or the chevron (now pointing up)
  opens a scrollable history window with the whole log; F2 and TEXTSCR open it
  too (`ui.toggle.history`, Window > Command History). Dragging the history's
  top edge sets how many lines show (`ui.cmdline.lines`, 0-12).
- ViewCube (new viewcube.rs): Top face and a Home button run `zoom.extents`;
  hover highlights; right-click menu (Home, Hide ViewCube). The compass ring
  says that the 2D plan view can't rotate (no view twist yet) instead of
  doing nothing.
- UCS icon and the WCS pill open the coordinate-system menu (World, Hide UCS
  Icon).
- Control channel: `ui.drag` (real press, move, release) and
  `cmdline.state` -> `historyExpanded`.

Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-10 12:16:27 -04:00

2.7 KiB

CADCraft control protocol

Start the desktop app with --control PORT (or CADCRAFT_CONTROL_PORT=PORT). It listens on 127.0.0.1:PORT for JSON lines: one request per line, one reply per line.

{"id": 1, "method": "cmdline.input", "params": {"text": "circle 0,0 5"}}
{"id": 1, "ok": true, "result": {"prompt": "Command:", "output": ["Command: CIRCLE"], ...}}

Errors come back as {"id": …, "ok": false, "error": "message"}.

Method Params What it does
cmdline.input {text} Type a line at the command line exactly like a user. Starts commands by name/alias and answers prompts (points x,y, @dx,dy, @d<a, distances, keywords, empty = Enter). Spaces act as Enter except at text prompts.
cmdline.script {text} Run a multi-line script (like .scr files).
cmdline.key {key: "enter"|"escape"} Press Enter or Escape.
cmdline.state Current prompt, keywords, accepted input kinds, history tail.
engine.execute {command, params} Run any command with JSON parameters. Never opens a dialog.
engine.commands Every command: id, label, menu path, shortcut, aliases, params doc, enabled.
drawing.inspect {entities?, limit?} Drawing summary (counts, extents, layers, styles, blocks, layouts, selection, undo) and entities with handles and geometry.
ui.inspect UI state, canvas rect, view, cursor and snap, performance counters.
ui.menu.list / ui.menu.invoke {command} The menu tree; invoke an item like a click (interactive).
ui.pointer {x, y, space?: "world"|"screen", button?, action?: "click"|"move"} Click in the drawing area (world coordinates by default). Right button = Enter.
ui.click / ui.move {x, y, button?, shift?} Real egui pointer events in screen points (reach every widget).
ui.drag {x, y, to: [x, y], button?} Real press, move and release (drag the command line's top edge, the ViewCube ring…).
ui.key / ui.text {key, cmd?, shift?, alt?} / {text} Synthetic keyboard input.
ui.set UiState fields Show/hide palettes, toolbars, command line, ViewCube…; theme: "system"|"light"|"dark" (also engine.execute with ui.theme {theme}); ui.inspect reports the theme shown (theme: light/dark).
ui.resize {width, height} Resize the window.
ui.screenshot {path?} PNG of the window (needs a presented frame).
ui.render {path?, width?, height?} Headless render of the current view of the drawing.
app.open / app.save / app.quit {path} File operations.

The MCP server (cadcraft-cli mcp --connect 127.0.0.1:PORT) wraps this protocol; headless (cadcraft-cli mcp) it serves the same methods from an in-process session.