Skip to main content
Run Codex on a repository in a machine with your project dependencies. You control the files, credentials, and working directory.

​
Before you start

Install and authenticate the CLI, choose a published coding template, and prepare an AI credential profile.

​
Create a machine

Replace ID below with the returned machine ID.

​
Prepare your repository

Clone a public repository into an explicit directory:
For local files, use file transfer. For private repositories, supply your own repository credentials through authenticated guest access. An AI profile does not establish repository access.

​
Give the agent a task

Replace PROFILE_UUID with your saved profile UUID. Retain a request UUID before dispatch so you can reuse it if the response is lost.
The working directory must already exist. The default is /root; /workspace is not created automatically.

​
Inspect the result

Read the runner’s terminal events and review the changes. Download the files you need before bead delete ID. See steering and approvals and parallel work.