CLI reference

Command	Purpose
run	Boot an image and run a command, then tear down
create	Create a named, persistent workspace
apply	Apply supported workspace spec changes without rebuilding
clone	Copy a stopped workspace into a new workspace
cp	Copy files into or out of stopped workspace disks
artifacts	List and retrieve declared workspace artifacts
network	Inspect workspace network mode and port forwards
start	Boot a stopped workspace
supervise	Start and restart a workspace according to policy
halt	Clean disk-preserving shutdown
quarantine	Sever host-side network and mediation
stop	Graceful shutdown
kill	Hard terminate
delete	Remove a workspace and its state
status	Show workspace state
result	Show structured workspace result
ps	List workspaces
logs	Show boot/serial output
connect	Open the workspace console
profiles	List exact named resource profiles
images	List or prune local image records
prune	Prune stale records and optional reusable image baselines
perf	Measure workspace boot performance
contract	Print the backend-neutral runtime contract
host	Report host backend capabilities
doctor	Check the host for backend support
rootfs	Build a rootfs from an OCI image
kernel	Install or verify a custom kernel
version	Print the version

Workspace spec

microagent.yaml is the declarative form of microagent create — image, profile, restart policy, networking, mounts, mediation, and outputs in a single file you can keep in source control.

Global flags

• --json — print JSON output; place before the subcommand
• --text — print human-readable output
• --output <json|text> — select output format
• --supervisor <path> — override the installed host backend supervisor path (MICROAGENT_APPLEVF_SUPERVISOR and MICROAGENT_FIRECRACKER_SUPERVISOR work too)

Output

All commands can print JSON output. With --json before the subcommand (or MICROAGENT_OUTPUT=json), the response matches the shape documented in the supervisor protocol. Scripts should consume JSON; humans get the text format by default.