Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Each agent file contains:

Browse the agents below and copy/adapt the ones you need!

### Option 3: Use with Other Tools (Cursor, Aider, Windsurf, Gemini CLI, OpenCode)
### Option 3: Use with Other Tools (Codex, Cursor, Aider, Windsurf, Gemini CLI, OpenCode)

```bash
# Step 1 -- generate integration files for all supported tools
Expand All @@ -55,6 +55,7 @@ Browse the agents below and copy/adapt the ones you need!

# Or target a specific tool directly
./scripts/install.sh --tool cursor
./scripts/install.sh --tool codex
./scripts/install.sh --tool copilot
./scripts/install.sh --tool aider
./scripts/install.sh --tool windsurf
Expand Down Expand Up @@ -509,6 +510,7 @@ The Agency works natively with Claude Code, and ships conversion + install scrip
- **[GitHub Copilot](https://github.com/copilot)** — native `.md` agents, no conversion needed → `~/.github/agents/` + `~/.copilot/agents/`
- **[Antigravity](https://github.com/google-gemini/antigravity)** — `SKILL.md` per agent → `~/.gemini/antigravity/skills/`
- **[Gemini CLI](https://github.com/google-gemini/gemini-cli)** — extension + `SKILL.md` files → `~/.gemini/extensions/agency-agents/`
- **[Codex](https://developers.openai.com/codex/multi-agent/)** — project-scoped multi-agent roles → `.codex/config.toml` + `.codex/agents/*.toml`
- **[OpenCode](https://opencode.ai)** — `.md` agent files → `.opencode/agents/`
- **[Cursor](https://cursor.sh)** — `.mdc` rule files → `.cursor/rules/`
- **[Aider](https://aider.chat)** — single `CONVENTIONS.md` → `./CONVENTIONS.md`
Expand Down Expand Up @@ -551,14 +553,16 @@ The installer scans your system for installed tools, shows a checkbox UI, and le
[ ] 8) [ ] Aider (CONVENTIONS.md)
[ ] 9) [ ] Windsurf (.windsurfrules)
[ ] 10) [ ] Qwen Code (~/.qwen/agents)
[ ] 11) [ ] Codex (.codex/config.toml)

[1-10] toggle [a] all [n] none [d] detected
[1-11] toggle [a] all [n] none [d] detected
[Enter] install [q] quit
```

**Or install a specific tool directly:**
```bash
./scripts/install.sh --tool cursor
./scripts/install.sh --tool codex
./scripts/install.sh --tool opencode
./scripts/install.sh --tool openclaw
./scripts/install.sh --tool antigravity
Expand Down Expand Up @@ -648,6 +652,31 @@ On a fresh clone, generate the Gemini extension files before running the install
See [integrations/gemini-cli/README.md](integrations/gemini-cli/README.md) for details.
</details>

<details>
<summary><strong>Codex</strong></summary>

Agency agents are converted into Codex multi-agent role files under `.codex/`.
Each role is registered in `.codex/config.toml` and points to a matching
`.codex/agents/<slug>.toml` file containing the agent instructions.

```bash
# Convert and install (run from your project root)
cd /your/project
/path/to/agency-agents/scripts/convert.sh --tool codex
/path/to/agency-agents/scripts/install.sh --tool codex
```

If your project already has `.codex/config.toml`, the installer leaves it
unchanged and writes `.codex/agency-agents.snippet.toml` for manual merging.

Prompt Codex to use the roles, for example:
```
Review this branch against main. Use frontend-developer for UI risks and reality-checker for release readiness.
```

See [integrations/codex/README.md](integrations/codex/README.md) for details.
</details>

<details>
<summary><strong>OpenCode</strong></summary>

Expand Down
27 changes: 26 additions & 1 deletion integrations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ supported agentic coding tools.
- **[GitHub Copilot](#github-copilot)** — `.md` agents, use the repo directly
- **[Antigravity](#antigravity)** — `SKILL.md` per agent in `antigravity/`
- **[Gemini CLI](#gemini-cli)** — extension + `SKILL.md` files in `gemini-cli/`
- **[Codex](#codex)** — `.codex/config.toml` + role files in `codex/`
- **[OpenCode](#opencode)** — `.md` agent files in `opencode/`
- **[OpenClaw](#openclaw)** — `SOUL.md` + `AGENTS.md` + `IDENTITY.md` workspaces
- **[Cursor](#cursor)** — `.mdc` rule files in `cursor/`
Expand All @@ -30,9 +31,14 @@ supported agentic coding tools.
# Gemini CLI needs generated integration files on a fresh clone
./scripts/convert.sh --tool gemini-cli
./scripts/install.sh --tool gemini-cli

# Codex is project-scoped and installs into .codex/
cd /your/project
/path/to/agency-agents/scripts/convert.sh --tool codex
/path/to/agency-agents/scripts/install.sh --tool codex
```

For project-scoped tools such as OpenCode, Cursor, Aider, and Windsurf, run
For project-scoped tools such as Codex, OpenCode, Cursor, Aider, and Windsurf, run
the installer from your target project root as shown in the tool-specific
sections below.

Expand Down Expand Up @@ -103,6 +109,25 @@ See [gemini-cli/README.md](gemini-cli/README.md) for details.

---

## Codex

Agents are converted into Codex multi-agent role files for a project-local
`.codex/` directory. The generated `config.toml` enables the `multi_agent`
feature and registers each role under `[agents.<slug>]`.

```bash
cd /your/project
/path/to/agency-agents/scripts/convert.sh --tool codex
/path/to/agency-agents/scripts/install.sh --tool codex
```

If `.codex/config.toml` already exists, the installer keeps it intact and
writes `.codex/agency-agents.snippet.toml` for manual merging.

See [codex/README.md](codex/README.md) for details.

---

## OpenCode

Each agent becomes a project-scoped `.md` file in `.opencode/agents/`.
Expand Down
71 changes: 71 additions & 0 deletions integrations/codex/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Codex Integration

Codex multi-agent support uses project-scoped role definitions in `.codex/`.
The Agency converter generates:

- `.codex/config.toml` with `[features] multi_agent = true`
- one `[agents.<slug>]` registration per agent
- `.codex/agents/<slug>.toml` role files with `developer_instructions`

This matches the official Codex multi-agent configuration model:
https://developers.openai.com/codex/multi-agent/

## Install

```bash
# Run from your project root
cd /your/project
/path/to/agency-agents/scripts/convert.sh --tool codex
/path/to/agency-agents/scripts/install.sh --tool codex
```

If your project does not already have `.codex/config.toml`, the installer
copies the generated config directly.

If `.codex/config.toml` already exists, the installer:

- copies all Agency role files into `.codex/agents/`
- leaves your existing `.codex/config.toml` unchanged
- writes `.codex/agency-agents.snippet.toml` for manual merging

## Generated Format

Example `.codex/config.toml`:

```toml
[features]
multi_agent = true

[agents]

[agents.frontend-developer]
description = "Expert frontend developer specializing in modern web technologies..."
config_file = "agents/frontend-developer.toml"
```

Example `.codex/agents/frontend-developer.toml`:

```toml
developer_instructions = '''
# Frontend Developer Agent Personality

You are **Frontend Developer** ...
'''
```

## Usage

Once installed, ask Codex to use the generated roles explicitly:

```text
Review this branch against main. Use frontend-developer to inspect UI regressions and reality-checker to assess release readiness.
```

You can also ask Codex to fan work out across multiple roles in parallel when
the `multi_agent` feature is enabled.

## Regenerate

```bash
./scripts/convert.sh --tool codex
```
Loading