Response types

1. How to read the table

A success envelope names its payload shape in type, and a caller reads that field before it parses data. Each row below is one value of type, the commands whose success envelope carries it, and the union of the data keys those commands declare.

The manifest lists 39 commands and 37 distinct types, so several commands share a shape. A command that emits a second shape under a flag is listed twice, with the flag named.

2. The types

Type	Emitted by	Keys in data
microvm.run	microvm run, microvm quickstart	imageIdentifier, imageName, microvmId, endpoint, agentToken, execExitCode, stdout, stderr, truncated, buildSeconds, runningSeconds, kept, vmName, leaked, cost, egressPosture, imageReused, artifactUri, resolvedConfig, configPath, sync, agentd
microvm.image	microvm build	imageIdentifier, imageName, buildLogGroup, logStream, size, reused, artifactUri, agentd
microvm.agent	microvm agent-up	vmName, microvmId, endpoint, agentToken, imageIdentifier, imageName, imageReused, vmReused, agents, credentialExpiresAt, workdir, project, egressPosture, agentd
microvm.agent.prompt	microvm agent-prompt	execId, agent, model, phase, exitCode, stdout, stderr, truncated, posixExitCode, notes, synthesized
microvm.exec	microvm exec, microvm ack	execId, exitCode, stdout, stderr, truncated, phase, posixExitCode, notes, synthesized
microvm.exec.stream	microvm exec with --stream	execId, events, bytes, nextOffset, exitCode, truncated, gaps
microvm.wait	microvm wait	microvmId, state, from, endpoint
microvm.health	microvm health	version, bootstrapped, identityDegraded, identityRepaired, diskAvailableBytes, diskUnderPressure, busy, execs, hooks, hooksDropped, identitySteps
microvm.discovery	microvm discovery	microvmId, available, defaultUser
microvm.keepalive	microvm keepalive	microvmId, end, polls, lastBusy, elapsedSec, intervalSec, idleWindowSec
microvm.kill	microvm kill	microvmId, execId, killed
microvm.procs	microvm ps	microvmId, procs
microvm.stdin	microvm stdin	execId, written, eof
microvm.copy	microvm cp	direction, bytes, local, remote, tar
microvm.exists	microvm exists	microvmId, path, exists
microvm.sync	microvm sync	microvmId, workdir, uploadedBytes, uploadedMembers, deleted, full, unchanged, passes, watched
microvm.attach	microvm attach	name, microvmId, endpoint, region, verifiedIdentity, replaced, statePath
microvm.adopt	microvm adopt	microvmId, state, endpoint, imageArn, stateReason, idleWindowSec
microvm.tunnel	microvm tunnel	microvmId, localPort, localAddress, guestPort, connectionsServed, connectionsRefused, connectionsTruncated, connectionsUnproven, proxyTokenMints, interrupted
microvm.port-forward	microvm port-forward	microvmId, localPort, localAddress, guestPort, connectionsServed, connectionsRefused, upgrades, proxyTokenMints, interrupted
microvm.shell	microvm shell	microvmId, sessionId, end, closeReason
microvm.state	microvm suspend, microvm resume	microvmId, state, endpoint
microvm.teardown	microvm terminate	microvmId, imageIdentifier, leaked, undeletedLogGroups, state
microvm.runs	microvm ls	runs, watch, source, remote, pruned
microvm.history	microvm history	microvmId, events
microvm.names	microvm names	names, deleted
microvm.logs	microvm logs	logGroup, lines, streams, tailCommand, tailRequires
microvm.image.versions	microvm image-versions	imageArn, versions
microvm.gc	microvm gc	dryRun, imagesMatched, imagesKept, microvmsMatched, microvmsTerminated, imagesDeleted, imagesInUse, failures
microvm.image.status	microvm image-set-status	imageArn, imageVersion, status, version
microvm.image.builds	microvm image-builds	imageArn, imageVersion, builds
microvm.cost	microvm cost	report, comparison, budget
microvm.egress-posture	microvm egress-posture	posture, detail, region, configPath
microvm.doctor	microvm doctor	checks, ok
microvm.manifest	microvm manifest	apiVersion, cli, version, commands, exitCodes, envelope, conventions
microvm.constants	microvm constants	constants
microvm.dockerfile	microvm dockerfile	stanza, baseImageName, baseImageDockerRef, port, workdir

Where commands share a type and declare different keys, the row above is the union. The differences:

• microvm.exec: microvm exec also carries posixExitCode, notes, synthesized.
• microvm.state: microvm resume also carries endpoint.

3. Provenance

This page is generated from docs/manifest.json, the output of microvm manifest. The table is a join over every command’s responseType, responseKeys and alternateResponse. site/scripts/gen-reference.mjs writes it into the site’s content directory on every pnpm run sync, so an edit made here is overwritten by the next run.

To change the page, change the source. Regenerate the source with mise run manifest from the repository root; mise run manifest:check fails when the committed file no longer matches what the binary emits.