wendy doctor
Check setup and print a sanitized local diagnostic report
Syntax
wendy doctor [flags]Examples
wendy doctor --helpArguments
No positional arguments are declared in the command synopsis.
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 |
|---|---|---|---|
--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 |
--project | string | (empty) | Project directory to check (default: current directory, when recognized) |
--report | bool | false | Print sanitized JSON to stdout; no upload or report file is created |
--timeout | duration | 20s | Maximum duration of all checks, up to one minute |
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
Read-only checks for a project, Docker, QEMU, and the selected target. Does not install tools, start a VM, deploy an app, refresh credentials, or upload the report. Missing optional context is reported as unknown.