Skip to main content
This guide starts a ready Simulator from your workspace or the shared catalog.
1

Install the CLI

Add ~/.local/bin to your PATH if the installer asks you to do so.
2

Sign in

Approve the browser prompt or paste a Workspace API key from the app.
3

Choose a ready Simulator

Copy a Simulator ID or a name:tag reference from the result.
4

Start a Simulation

The seed and clock start pin injected randomness and virtual time. Save the returned Simulation ID, endpoint, and token. The command returns the token only once.
5

Inspect the Simulation

The first command shows lifecycle state and the endpoint. The second command shows the simulated system API.

​
Call the simulated system

Each Simulator defines its own paths. Send the one-time Simulation token to its endpoint.
The Simulation token authenticates only its data-plane endpoint. Your Workspace API key authenticates supported control-plane routes.
Use the API reference for exact control-plane requests, responses, and authentication rules.

Understand Simulations

Learn about state, seeds, tokens, and lifecycle controls.

Connect systems

Use a World when an agent needs more than one system.