wendy vm serial
Show or configure host serial passthrough for a stopped VM
Syntax
wendy vm serial [name] [flags]Examples
wendy vm serial --helpArguments
Argument notation from the CLI: [name]. Angle brackets mark required values; square brackets mark optional values. See Details for command-specific validation.
Flags
Flags below include inherited options. Types and defaults come from the CLI source. An empty default means no value is configured.
| Flag | Type | Default | Description |
|---|---|---|---|
--baud | uint32 | 0 | Exact baud supported by the host driver; no rounding |
--clear | bool | false | Remove the persisted mapping |
--device | string | (empty) | Target device host (hostname, IP, or host:port); 'wendy run' accepts a comma-separated list to deploy one build to several devices (needs a remote build host and --detach). Defaults to $WENDY_DEVICE, then the saved default device |
--json | bool | false | Output in JSON format |
--port | string | (empty) | Host serial port: COM12 on Windows, /dev/cu.usbmodem… on macOS, /dev/ttyACM0 or /dev/serial/by-id/… on Linux |
--yes / -y | bool | false | Accept prompts, including installing QEMU when it is missing (Linux still asks before running sudo) |
Output
Output depends on the operation and selected target. Command behavior and detailed examples.
JSON output
The global --json option requests machine-readable output. The CLI also selects JSON mode when no interactive terminal is attached. Support and payloads are command-specific; this flag does not guarantee a single JSON document for commands that stream logs or invoke build tools. Consult Details before parsing command output.
Exit codes
The CLI entry point returns 0 on success and for its user-cancelled or default-cleared results. Other returned errors exit with 1 and print a diagnostic to stderr. Some operations may terminate through subprocess or signal handling; do not infer application health from the CLI exit code alone.
Common errors
Check argument values and flag combinations against the synopsis above. For discovery, build, port, and readiness failures, see deployment troubleshooting. Command-specific constraints are in Details.
See also
Details
Persist one host serial port and exact baud for foreground VM starts: a COM port on Windows, a /dev path on macOS and Linux. Uses 8N1, no handshake, DTR/RTS disabled. Guest baud changes do not alter the host. Stop the VM before changing its mapping.