Guide/Start here

Quickstart

Create a task, run your local Codex, and review the changes.

On this page
What you will do

Create a task to document your project’s development setup, run Codex, and check the result.

Set upCreate a taskRun CodexCheck the result

Before you start

  • A Mac with Agentboard installed.
  • Codex CLI installed and signed in on the same Mac.
  • A local project folder with a README and development commands to document.

Sign in to Agentboard and choose a workspace with an active trial or subscription.

Installing and checking Codex CLI

If Codex CLI is not installed, follow its official installation guide. Then check the version and sign in from your terminal.

Terminal
codex --version
codex login

Codex CLI documentation ↗

Connect your project folder

  1. Open Projects in the sidebar, then select New project. Enter a name such as “Website” and select Create project.
  2. Select the project you created. Under Local repository on this device, select Choose directory and choose your project folder.
Interface diagram · example content
Projects
1Website
Select a project
Local repository on this device~/Projects/website
Choose directory2
Choose its folder
The local directory setting tells Codex where to work.

The selected folder path appears in the project settings.

Create your first task

  1. Open All tasks → New task. Enter “Document the local development setup” and select Create task.
  2. Open the new task. Set Project to the project you just created, then paste the following into the description. Click outside the description to save it.
Task description
Add a “Local development” section to the README.
Read the repository’s existing configuration and document the install, development server, and test commands that actually exist.
Keep other files unchanged. Finish with a summary of what you added and any commands you could not verify.

The task is on the board, with a project and a saved description.

Start Codex

In the task details, open Executions and select Start Codex.

Interface diagram · example content
WEB-1Document the local development setup
1ExecutionsPull requestsActivity
Agent executions Start Codex2
No agent executions yet.
Start the run from the task’s Executions tab.

A new execution appears. Its status updates as Codex works.

If Codex requests approval or asks a question, respond from the Mac where you started the run.

Check the result

When the run finishes, open the README in your editor and review the diff.

  • The README contains the new local development section.
  • The listed commands match the project’s configuration.
  • Only the intended files changed.

Need an adjustment? Add a follow-up instruction to the execution. For example:

Follow-up instruction
Add the required Node.js version to the same section, using the repository configuration as the source.

You have completed the task → run → review workflow.

Troubleshooting

Start Codex is unavailable

Check that Codex CLI is installed and signed in, the task has a project, and that project has a local directory on this Mac. Also check whether the workspace allows edits.

The task was created, but nothing is running

Creating a task does not start Codex. Open the task’s Executions tab and select Start Codex.

Next guideTasks and agent runsTrack progress, continue runs, and connect pull requests.