Skip to main content

Codex + Soul Spec

Codex is OpenAI's CLI agent that reads persona configuration from an AGENTS.md file in your project. Soul Spec personas integrate seamlessly — install and the persona is merged into your project's AGENTS.md.

Soul Spec gives Codex a real identity. Install a soul, and the persona is merged into your project's AGENTS.md inside special clawsouls markers, preserving any existing agent configuration.

Quick Start (2 minutes)

Step 1: Install the CLI

npm install -g clawsouls

Step 2: Install a soul

clawsouls install TomLeeLive/brad --use codex

This automatically merges the Soul Spec persona into your project's AGENTS.md file. If no AGENTS.md exists, one is created.

Step 3: Run Codex

codex

Or from your project directory:

cd my-project
codex

Codex reads AGENTS.md and adopts the persona automatically.

AGENTS.md Structure

After installation, your AGENTS.md contains:

# Agent Configuration

<!-- clawsouls:start -->
# Brad — Developer

You are Brad. A pragmatic developer...

## Principles
- [Core behaviors from SOUL.md]

## Communication Style
- [Style from STYLE.md]
<!-- clawsouls:end -->

# Your Custom Sections

Any existing content outside the clawsouls markers is preserved.

The soul is wrapped in <!-- clawsouls:start --> and <!-- clawsouls:end --> markers. This allows you to:

  • Keep existing AGENTS.md sections untouched
  • Update the persona by running clawsouls install again
  • Manually edit sections outside the markers

Installation Location

The persona is merged into AGENTS.md at your project root:

my-project/
├── AGENTS.md ← Persona merged here
├── src/
└── ...

Codex discovers AGENTS.md automatically when you run the codex command.

Switching Personas

To change personas, run install again with a different soul:

clawsouls install clawsouls/ellie --use codex

The AGENTS.md is updated automatically — the clawsouls section is replaced with the new persona, and your custom sections are preserved.

File Mapping

Soul Spec FileMerged IntoNotes
SOUL.mdAGENTS.md✅ Personality & tone
IDENTITY.mdAGENTS.md✅ Merged into persona section
STYLE.mdAGENTS.md✅ Communication style
AGENTS.mdAGENTS.md✅ Workflow rules
Other files⏭️ Not merged (Codex uses AGENTS.md only)

Version Control

Commit AGENTS.md to share personas with your team:

git add AGENTS.md
git commit -m "chore: update persona with clawsouls"

Team members will inherit the same persona when they run codex.

Tips

  • Preserve custom sections. Add your own agent configuration outside the clawsouls markers.
  • Update easily. Run clawsouls install <owner/name> --use codex to switch personas anytime.
  • Git-friendly. Commit AGENTS.md to ensure team consistency.
  • Manual editing. You can edit sections outside the markers without affecting persona updates.
  • Backup before updating. Consider committing before updating to easily revert if needed.

Editing AGENTS.md

If you need to add custom agent configuration:

  1. Add sections outside the markers:

    <!-- clawsouls:start -->
    [Auto-managed persona section]
    <!-- clawsouls:end -->

    ## Custom Workflow
    - My custom rules here
    - They won't be overwritten by updates
  2. Update persona: Run clawsouls install again — only the clawsouls section updates.

  3. Your custom sections remain unchanged.