Skip to content

codex.md

Latest commit

 

History

History
58 lines (40 loc) · 1.91 KB

codex.md

File metadata and controls

58 lines (40 loc) · 1.91 KB

Codex Usage

This is an advanced guide. For the recommended public setup path, start with docs/README.md or Quick Start.

Fleet Pi ships a shared Codex local environment so new Codex worktree threads can bootstrap the repo consistently.

If you just want to run Fleet Pi locally as a web app, start with docs/quickstart.md instead. This page is the advanced path for Codex worktrees.

Shared Environment

  • Environment definition: .codex/environments/environment.toml
  • Setup entrypoint: .codex/workspace-bootstrap.zsh

Open the Fleet Pi repo in the Codex app and choose the shared local environment when starting a worktree-backed thread.

Setup Behavior

The current setup script is intentionally bootstrap-only:

# from repo root
pnpm install --frozen-lockfile

This matches the repo's normal dependency flow and keeps worktree creation predictable.

It also keeps setup separate from canonical workspace state: agent-workspace/ remains the durable adaptive layer, while Codex setup only bootstraps the local worktree so later commands can operate on the repo safely.

Expectations

  • node and pnpm must already be available on the machine.
  • The script should stay focused on dependency/bootstrap work.
  • Do not put long-running processes in the setup script.
  • Do not rely on export statements in the setup script for later Codex turns; setup runs in a separate shell session.

For the accepted workspace contract, see docs/adaptive-workspace.md.

Suggested Codex Actions

After the worktree is ready, add separate Codex actions for the common repo tasks instead of bundling them into one multi-step action:

  • Dev -> pnpm dev
  • Typecheck -> pnpm typecheck
  • Test -> pnpm test

pnpm dev is long-running, while the others are one-shot validation commands, so keeping them split makes the Codex action bar much more usable.