Skip to main content
Run cloud coding agents on a machine with the agents, computer, or devbox tool payload. Check the published template catalog before selecting an image.

Prepare the directory

Upload or clone your code there. A prompt’s cwd must exist; the CLI defaults to /root.

Send a prompt

Select a saved credential profile. Keep a stable request UUID before dispatch:
The prompt API accepts requestId, prompt, cwd, optional profileId, and optional model. Use --model when you need a model supported by the installed runner and provider. The CLI prints the request UUID before sending the prompt. Reuse it with the same prompt if the response is lost. A newly generated UUID identifies new work.

Watch and inspect

Events show the turn’s progress. status reads conversation and turn state through GET /sandboxes/{id}/conversation. Read terminal events before concluding the task succeeded. MCP exposes bead:runner_prompt, bead:runner_events, and bead:runner_status. These use the same authenticated routes.

Control the turn

You can steer, interrupt, or answer approvals while work runs. Credential snapshot permission is explicit: --allow-credential-snapshot authorizes that policy for delivered credentials. Do not enable it for a source you do not intend to capture with credentials. For a complete repository workflow, see run an agent on your repository. For browser and native application work, see desktop use.