Skip to content
microvms-agentd
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
For agents
Learn
Overview
Tutorials
Install the CLI or an SDK
Configure AWS and run your first sandbox
Keep a VM running and work inside it
Run a project through a VM
Use the SDKs
How-to
Write a guest Dockerfile
Embed agentd in your own image
Run coding agents in sandboxed MicroVMs
Remote dev with code-server over port-forward
Prefetch S3 content at image build
Read the cost report
Debug a failed build
Recover a leaked VM
Configure the project file
Drive it from a script or an agent
Run the live suite
Configure networking
Reference
Overview
Envelope
Exit codes
Response types
Wire schema
Architecture drift
Commands
run
quickstart
build
agent-up
agent-prompt
exec
wait
health
discovery
keepalive
ack
kill
ps
stdin
cp
exists
sync
attach
adopt
tunnel
port-forward
shell
suspend
resume
terminate
ls
history
names
logs
image-versions
gc
image-set-status
image-builds
cost
egress-posture
doctor
manifest
constants
dockerfile
Python SDK
Overview
Functions and exceptions
Classes
AgentSpec
AgentVm
Amount
BaseImage
BearerToken
BudgetVerdict
BuildHookTimeout
ByteStream
ConnectionEnd
ControlPlane
CostReport
Detached
Discovery
DownloadedFile
Duration
EnsuredImage
EstimatedUsd
ExecHandle
ExecProcess
ExecResult
ExecStream
Exit
Gap
HandlerOutcome
Health
HookObservation
IdentityStep
IdlePolicy
Image
ImageBuild
ImageSummary
ImageVersion
KeepAwake
KeepAwakeReport
LineItem
ManagedBaseVersion
Microvm
MicrovmSummary
NameRecord
NameRegistry
OutputChunk
OutputGap
PortForward
PortForwardReport
PreflightCheck
PreflightReport
ProcGroup
ProvisionedAgentd
RateTable
Region
ResidencyComparison
RunHookTimeout
Sandbox
Session
SizeClass
StdinAck
SweepFailure
SweepReport
SyncReport
TeardownReport
Total
Tunnel
TunnelIdentity
TunnelReport
Unpriced
TypeScript SDK
Overview
Functions and enums
Classes
AgentVm
Amount
BearerToken
BudgetVerdict
BuildHookTimeout
ControlPlane
CostReport
Detached
Duration
EstimatedUsd
ExecHandle
ExecProcess
ExecStream
KeepAwake
LineItem
NameRecord
NameRegistry
PortForward
RateTable
Region
ResidencyComparison
RunHookTimeout
Sandbox
Session
SizeClass
Total
Tunnel
TunnelIdentity
Unpriced
Interfaces
AgentEnsureOptions
AgentImageOptions
AgentLaunchOptions
AgentSpec
AgentSpecInput
BaseImageInput
BuildImageOptions
CompletionRequest
ConnectionEnd
DeleteImageOptions
DetachedObject
Discovery
DownloadedFile
DownloadFileOptions
EnsuredImage
EnsureImageOptions
ExecOptions
ExecResult
HandlerOutcome
Health
HookObservation
IdentityStep
IdlePolicy
Image
ImageBuild
ImageSummary
ImageVersion
KeepAwakeOptions
KeepAwakeReport
LaunchMetrics
ListMicrovmsOptions
ManagedBaseVersion
Microvm
MicrovmSummary
NameRecordObject
OutputGap
PlanUsageOptions
PortForwardReport
PreflightCheck
PreflightReport
ProcessExit
ProcGroup
PromptOptions
ProvisionedAgentd
ProvisionOptions
RetryDetails
RetryOptions
RunOptions
RunUsageOptions
ServeOptions
SpawnOptions
StdinAck
StreamEvent
StreamOptionsInput
SweepFailure
SweepOptions
SweepReport
SyncDirOptions
SyncReport
TeardownOptions
TeardownReport
TunnelReport
WaitForStateOptions
WrapDockerfileOptions
Annotated
CLI
Public API
RPC tools
Internals
Overview
Authoritative
Platform
Networking
Suspend and resume
Stability
Protocol
Trust
Embedding
Strategy
Harness capabilities
Agent VMs
CLI coverage plan
Traceability
Architecture
Data flow
Module map
System overview
Behavior
Processes
State machines
Analysis
Dead code
Ownership
Risk hotspots
Diagrams
Components
Components
Structure
Dependency graph
Sequences
Sequences
Insights
Business logic
Contract map
Debugging guide
Impact analysis
Tech debt
Glossary
GitHub
Select theme
Dark
Light
Auto
Components
Copy as Markdown
View as Markdown
Open in ChatGPT
Open in Claude
Open in Claude Code
Open in Cursor
<<interface>>
CoreSeam
+
control_plane(region)
+
open_sandbox(region, port)
+
attach_session(region, attach)
Sandbox
+
build_image(request)
+
run(request)
+
suspend()
+
resume()
+
terminate(opts)
ControlPlane
+
create_image(request)
+
run_microvm(request)
+
wait_for_running(id, opts)
+
terminate(id)
+
mint_auth_token(id)
Session
+
health()
+
wait_until_ready(timeout)
+
run(req)
+
run_sync(req, timeout)
+
upload_tar(remote, archive)
ExecHandle
+
poll()
+
wait(timeout)
+
stream()
+
write_stdin(data, eof)
+
ack()
<<module>>
Routes
+
app(state)
+
handler_for(endpoint)
+
surface_docs()
AppState
+
config()
+
disk_guard()
+
identity_report()
+
with_execs(f)
<<module>>
Exec
+
start(state, body)
+
poll(state, id)
+
stream(state, id, query)
+
write_stdin(state, id, body)
+
ack(state, id)
constructs
constructs
constructs
owns
owns
creates
requests
requests
dispatches
reads
accesses
See also
Section titled “See also”
These pages cite many of the same source files as this one.
contract map
module map
processes
business logic
impact analysis