microvm sync

1. Synopsis

Sync a project directory into a running MicroVM’s /workspace, uploading only what changed

microvm sync <dir> [options]

2. Parameters

Parameter	Kind	Type	Required	Default	Choices	Help
dir	positional	path	yes	none	any	The project directory to sync. Packed with run <DIR>’s rules: .git, target, node_modules and .venv stay home, symlinks travel as links, and the daemon’s body and member budgets are enforced during the walk
--watch	flag	boolean	no	none	any	Keep syncing on filesystem changes until Ctrl-C
--full	flag	boolean	no	none	any	Upload the whole tree even when the guest manifest claims members are unchanged
--timeout	flag	string	no	60	any	How long the in-guest deletion of locally-removed paths may take, in seconds
--endpoint	flag	string	no	none	any	The VM’s endpoint, as reported by run
--agent-token	flag	string	no	none	any	The agent token delivered to the VM at launch
--microvm-id	flag	string	no	none	any	The MicroVM id, needed to mint the endpoint proxy token
--name	flag	string	no	none	any	The name run --keep --vm-name registered, standing in for the whole triple
--port	flag	string	no	none	any	The daemon’s port inside the guest
--state-dir	flag	path	no	none	any	Where the local state lives — the name registry, and exec’s per-VM history. 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

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.

3. Response

On success stdout carries one envelope whose type is microvm.sync. Its data object carries these keys: microvmId, workdir, uploadedBytes, uploadedMembers, deleted, full, unchanged, passes, watched.

The envelope describes the fields around data. 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 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.

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