For an agent. Start with microvm manifest. It returns commands, flags, response types, and
exit codes as JSON without credentials or network access. microvm manifest --dense gives a compact command list. Prefer the installed binary’s contract
over prose that may describe a different version.
1. Automation
Section titled “1. Automation”- Use
--json. Commands write one envelope to stdout and progress to stderr.exec --streamemits NDJSON events and the final envelope. - Branch on error
codeandexitCode, not message text.ERR_EXEC_FAILEDmeans the command in the VM failed; it does not imply an AWS failure. - Read
leakedafter cleanup. Teardown is attempted by default, but failures and process termination can leave resources behind.microvm ls --remotecompares the local ledger with AWS. - Keep per-VM secrets out of shared images. The guest can access its execution role; user demotion does not hide it.
- No internet egress requires a VPC without an IGW or NAT gateway. Neither
omitting
--egressnor setting--deny-egressenforces isolation. - Keep
agentdas the image’sCMDand start workloads only after bootstrap.
2. Entry points
Section titled “2. Entry points”| Task | Contract or guide |
|---|---|
| CLI integration | microvm manifest, Reference |
| Direct daemon integration | GET /v1/schema, Protocol |
| Rust, Python, Node | Libraries |
| First AWS run | First-run tutorial |
| Coding agents inside a VM | Agents on Bedrock |
| Network isolation | Networking |
| Image integration | Embedding |
microvm doctor checks prerequisites before a build. quickstart creates
billable AWS resources, runs a hello-world, and attempts cleanup. Reuse images
with --image to avoid unnecessary builds and retention charges.
3. Repository work
Section titled “3. Repository work”Read CONTRIBUTING.md. Run mise run check for local verification and
mise run docs:check for documentation. Live AWS behavior needs a separate
exercise of the changed path; mise run live is billable. Report when it has
not been run, and verify cleanup independently afterward.
Edit site/authored/ for user guides and top-level docs/*.md for contracts.
site/src/content/docs/ is generated. References generated from source contain
commit-pinned citations that may be stale in the current checkout; check the
source instead of treating prose as proof. Record new AWS measurements with
date, region, and API version, retaining earlier observations.
4. Read next
Section titled “4. Read next”5. Machine-readable documentation
Section titled “5. Machine-readable documentation”Append .md to a page path: /reference/cli/ becomes /reference/cli.md.
Fetch the individual page when its location is known.
llms.txt indexes the corpus; llms-small.txt and
llms-full.txt provide bundles. schema.json
is the generated daemon wire contract.