Interactive editor commands

The standalone editors require a graphical desktop, the UI app included with the runtime, and a running runtime. Build your design before opening an editor.

jitx ui

Use open to launch an editor; the group itself shows help.

jitx ui open

Pass exactly one of --board or --schematic. Without --port, use the running runtime for the resolved project. An explicit port targets that WebSocket port. Without --design, auto-select a single discovered design or prompt when several exist; supply a fully qualified name in scripts. The command remains attached to the editor process until it exits.

jitx ui open --board --design myboard.main.Myboard
jitx ui open --schematic --design myboard.main.Myboard

Argument / option	Default	Meaning
--project	unset	JITX project root (directory containing pyproject.toml with jitx as a dependency). Defaults to walking up from the current directory.
--port	unset	Websocket port the runtime is listening on. Defaults to the port announced by the runtime in the resolved project.
--board	false	Open the interactive board (PCB layout) editor.
--schematic	false	Open the interactive schematic editor.
--design	unset	Fully-qualified design name (e.g. ‘mypkg.main.MyDesign’). Accepted with or without the ‘design/’ routing prefix the runtime uses internally. If omitted, the project is scanned and the design is auto-picked (single match) or chosen interactively (multiple).