Skip to content

For agents

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.

  • Use --json. Commands write one envelope to stdout and progress to stderr. exec --stream emits NDJSON events and the final envelope.
  • Branch on error code and exitCode, not message text. ERR_EXEC_FAILED means the command in the VM failed; it does not imply an AWS failure.
  • Read leaked after cleanup. Teardown is attempted by default, but failures and process termination can leave resources behind. microvm ls --remote compares 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 --egress nor setting --deny-egress enforces isolation.
  • Keep agentd as the image’s CMD and start workloads only after bootstrap.
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.

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.

Read this Raw Markdown
Learn learn.md
Install the CLI or an SDK learn/tutorial/install.md
Configure AWS and run your first sandbox learn/tutorial/first-run.md
Keep a VM running and work inside it learn/tutorial/long-lived-vm.md
Run a project through a VM learn/tutorial/run-a-project.md
Use the SDKs learn/tutorial/from-code.md
Configure networking learn/operations/configure-networking.md
Write a guest Dockerfile learn/operations/write-a-guest-dockerfile.md
Embed agentd in your own image learn/operations/embed-agentd-in-your-image.md
Run coding agents in sandboxed MicroVMs learn/operations/run-coding-agents-on-bedrock.md
Remote dev with code-server over port-forward learn/operations/remote-dev-with-code-server.md
Prefetch S3 content at image build learn/operations/prefetch-s3-at-build.md
Read the cost report learn/operations/read-the-cost-report.md
Debug a failed build learn/operations/debug-a-failed-build.md
Recover a leaked VM learn/operations/recover-a-leaked-vm.md
Configure the project file learn/operations/configure-the-project-file.md
Drive it from a script or an agent learn/operations/drive-it-from-a-script-or-an-agent.md
Run the live suite learn/operations/run-the-live-suite.md
Reference reference.md
microvm ack reference/commands/ack.md
microvm agent-prompt reference/commands/agent-prompt.md
microvm agent-up reference/commands/agent-up.md
microvm attach reference/commands/attach.md
microvm build reference/commands/build.md
microvm constants reference/commands/constants.md
microvm cost reference/commands/cost.md
microvm cp reference/commands/cp.md
microvm dockerfile reference/commands/dockerfile.md
microvm doctor reference/commands/doctor.md
microvm exec reference/commands/exec.md
microvm health reference/commands/health.md
microvm history reference/commands/history.md
microvm kill reference/commands/kill.md
microvm logs reference/commands/logs.md
microvm ls reference/commands/ls.md
microvm manifest reference/commands/manifest.md
microvm port-forward reference/commands/port-forward.md
microvm ps reference/commands/ps.md
microvm quickstart reference/commands/quickstart.md
microvm resume reference/commands/resume.md
microvm run reference/commands/run.md
microvm shell reference/commands/shell.md
microvm stdin reference/commands/stdin.md
microvm suspend reference/commands/suspend.md
microvm sync reference/commands/sync.md
microvm terminate reference/commands/terminate.md
microvm tunnel reference/commands/tunnel.md
The envelope reference/envelope.md
Exit codes reference/exit-codes.md
Response types reference/response-types.md
Wire schema reference/wire-schema.md
CLI reference/cli.md
Public API reference/public-api.md
RPC tools reference/rpc-tools.md
Internals internals.md
Networking internals/networking.md
AWS Lambda MicroVMs: measured platform behavior internals/platform.md
Wire protocol v1 internals/protocol.md
The trust contract for a control daemon inside a Lambda MicroVM internals/trust.md
Embedding agentd in your own image and driving it from your own harness internals/embedding.md
Strategy: the trust and preparation contract for coding agents on microVMs internals/strategy.md
What agent harnesses require of this platform internals/harness-capabilities.md
Agent VMs: the L3 helpers over the primitives internals/agent-vms.md
Plan: full live coverage through the microvm CLI internals/cli-coverage-plan.md
Data flow internals/architecture/data-flow.md
Module map internals/architecture/module-map.md
System overview internals/architecture/system-overview.md
Processes internals/behavior/processes.md
State machines internals/behavior/state-machines.md
Dead code internals/analysis/dead-code.md
Ownership internals/analysis/ownership.md
Risk hotspots internals/analysis/risk-hotspots.md
Components internals/diagrams/architecture/components.md
Sequences internals/diagrams/behavioral/sequences.md
Dependency graph internals/diagrams/structural/dependency-graph.md
Business logic internals/insights/business-logic.md
Contract map internals/insights/contract-map.md
Debugging guide internals/insights/debugging-guide.md
Impact analysis internals/insights/impact-analysis.md
Tech debt internals/insights/tech-debt.md
Glossary glossary.md

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.