Get started
Start with the CLI
Give agents and automation a stable command interface to OpenMetal.
The OpenMetal CLI is the primary execution interface for coding agents, terminal workflows, and CI.
Install
The CLI requires Node.js 22 or later when installed from npm.
npm install --global @openmetal/cliConfigure access
Create an OpenMetal account, then run guided setup in a trusted terminal. It opens browser authentication, selects or creates an organization and project, and creates a project API key.
openmetal setup
openmetal doctorThe key is shown once
Setup prints a newly created project API key once. Do not run this step in recorded terminals or CI logs.
Create a sandbox
openmetal sandbox create \
--environment metal/node \
--environment-version latest \
--vcpu 2 \
--memory-mb 4096 \
--runtime-timeout 1800Interactive commands wait for completion. In automation, request the accepted response and wait explicitly:
openmetal --json --no-input sandbox create \
--environment metal/node \
--environment-version latest \
--vcpu 2 \
--memory-mb 4096 \
--runtime-timeout 1800 \
--async
openmetal operation wait <operation-id> --timeout 180Inspect and clean up
openmetal sandbox list
openmetal sandbox get <sandbox-id>
openmetal sandbox delete <sandbox-id> --yes