Skip to content

microvm dockerfile

Print the Dockerfile stanza that wraps any base image with agentd

Terminal window
microvm dockerfile [options]
Parameter Kind Type Required Default Choices Help
--from flag string no none any The image ref for the FROM line. Defaults to the managed al2023 base’s pair
--port flag string no 9000 any The port agentd listens on inside the guest
--workdir flag string no none any A working directory to create and set. Strongly recommended
--wrap flag path no none any Append the agentd stanza to this task Dockerfile rather than print the default one
--preserve-user flag boolean no none any With --wrap: preserve the builder-resolved final USER as the workload default. The daemon still starts as root. Explicit image and request users take precedence
--inherit-workdir flag boolean no none any With --wrap: the exec working directory is the image’s own WORKDIR, so one must be declared, by the task or by --workdir
--agent flag enum no none claude-code, codex Print the Dockerfile of an agent VM image carrying this agent, the one agent-up builds. Repeatable
--claude-version flag string no none any With --agent: pin the Claude Code npm package to this version
--codex-version flag string no none any With --agent: pin the Codex npm package to this version

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.

On success stdout carries one envelope whose type is microvm.dockerfile. Its data object carries these keys: stanza, baseImageName, baseImageDockerRef, port, workdir.

The envelope describes the fields around data. Response types lists every type the CLI emits and which commands share each one.

A failure exits with one of the statuses on Exit codes and writes the error shape on The 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.

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 dockerfile 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.