---
title: microvm quickstart
description: "Zero to a live exec: provision the daemon, build, launch, run, report, tear down"
---

## 1. Synopsis

Zero to a live exec: provision the daemon, build, launch, run, report, tear down

```sh
microvm quickstart [options]
```

## 2. Parameters

| Parameter | Kind | Type | Required | Default | Choices | Help |
| --- | --- | --- | --- | --- | --- | --- |
| `--exec` | flag | `string` | no | `echo hello from a microvm` | any | The command to run inside the first VM |
| `--state-dir` | flag | `path` | no | none | any | Where the run ledger and the provisioned-daemon cache live. Defaults to $MICROVM\_STATE\_DIR or ~/.microvm/runs |
| `--region` | flag | `enum` | no | none | `us-east-1`, `us-east-2`, `us-west-2`, `eu-west-1`, `ap-northeast-1` | AWS region. Defaults to $AWS\_REGION, then $AWS\_DEFAULT\_REGION, then us-east-1 |
| `--unlisted-region` | flag | `string` | no | none | any | Use a region this client has not seen carry MicroVMs. Costs you the diagnostic |
| `--bucket` | flag | `string` | no | none | any | S3 bucket for the build artifact. Defaults to $MICROVM\_BUCKET |
| `--build-role-arn` | flag | `string` | no | none | any | Build role ARN. Defaults to $MICROVM\_BUILD\_ROLE\_ARN |
| `--execution-role-arn` | flag | `string` | no | none | any | Execution role ARN. Defaults to $MICROVM\_EXECUTION\_ROLE\_ARN |

The 3 global flags (`--json`, `--dense`, `--quiet`) are accepted here as on every command, and are left out of the table above for that reason; see [Global flags](/microvms-agentd/reference/#3-global-flags).

## 3. Response

On success stdout carries one envelope whose `type` is `microvm.run`. Its `data` object carries these keys: `imageIdentifier`, `imageName`, `microvmId`, `endpoint`, `agentToken`, `execExitCode`, `stdout`, `stderr`, `truncated`, `buildSeconds`, `runningSeconds`, `kept`, `vmName`, `leaked`, `cost`, `egressPosture`, `resolvedConfig`, `configPath`, `sync`, `agentd`.

[The envelope](/microvms-agentd/reference/envelope/) describes the fields around `data`. [Response types](/microvms-agentd/reference/response-types/) lists every `type` the CLI emits and which commands share each one.

## 4. Failures

A failure exits with one of the statuses on [Exit codes](/microvms-agentd/reference/exit-codes/) and writes the error shape on [The envelope](/microvms-agentd/reference/envelope/): a stable `code` to branch on, an `exitCode` that matches the process status, a human-readable `error`, and `suggestions`.

Where a failure is one this project has measured on the platform, the envelope's `finding` names the section of the platform notes that documents it. The exit-code table links each one.

## 5. Provenance

This page is generated from `docs/manifest.json`, the output of `microvm manifest`, which the CLI derives from its own argument tree. This page reads the `quickstart` entry of `data.commands`. `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.