Doctor-X CLI

Doctor-X is a CLI-powered playbook runner for machine, network, and service diagnostics/remediation.

Two commands

| Where | Command | What it does | |-------|---------|--------------| | Any station (usually your console) | doctor-x play -s <playbook> | Start the playbook. Queues remote work when needed. | | Target machine | doctor-x work | Do the queued work. No flags needed. |

Example:

# Console — start once
doctor-x play -s wg-ingress

# Gateway server — just work
cd ~/x-doctor-shared-space
doctor-x work

Install

npm install -g @x12i/doctor-x@latest
doctor-x --version

Shared folder

No prior init required — use the all-in-one doctor-x-space playbooks:

# File server (once)
doctor-x play -s doctor-x-space-host

# Every other station (once)
doctor-x play -s doctor-x-space
# or: doctor-x play -s doctor-x-space-client

These create or connect to the canonical share name doctor-x-space, then initialize Doctor-X on that station automatically.

Manual init still works:

doctor-x init --shared-space "<path-to-shared-folder>"

--host is optional. On a handoff target you can also cd into the shared folder and run doctor-x work without init.

Playbook aliases

• wg-ingress → wg-public-endpoint-ingress-regression
• doctor-x-space / doctor-x-space-client → platform client playbook (mount/map + init)
• doctor-x-space-host → platform host playbook (create share + init)
• smb-mount / smb-persistent-mount → smb-share-persistent-mount (Linux persistent SMB mount)

Check situation on any station

doctor-x status

Shows shared folder, all known stations, pending jobs, handoffs, and latest run results.

Check everything this station knows

doctor-x check

Runs all applicable checks: CLI install, shared folder read/write, station identity, fleet/job state, and scenario-specific probes (WireGuard on Linux gateway, SMB mount, etc.).

doctor-x check              # on Linux gateway — includes root-required probes
doctor-x check --group wireguard # only WireGuard readiness
doctor-x check --json

Resume after a failure

doctor-x resume

On the console (x2) this re-runs the last failed playbook. On the gateway (x9) it runs doctor-x work. On Linux the CLI auto-elevates with sudo (preserving your PATH for nvm/fnm) when root is required — just run doctor-x resume.

doctor-x resume --dry-run   # show plan only
doctor-x resume --json

doctor-x status --host gateway-server
doctor-x status --json

SSH option

To run a remote target from the console without handoff:

doctor-x context set-host gateway-server --ssh-host 192.168.10.31 --ssh-user root --default
doctor-x play -s wg-ingress