Skip to main content

USE SWAMP WITH CODEX

Prerequisites

Initialize the repository

$ swamp repo init --tool codex

You will see output like:

20:46:55.279 INF repo·init Initialized swamp repository at "/path/to/your/repo" (tool: "codex")

What this sets up

Swamp adds its rules and skill list to AGENTS.md and copies bundled skills to .agents/skills/, where Codex auto-discovers them. Your own project instructions coexist in AGENTS.md via managed sections — swamp only touches its own delimited block.

Use alongside another agent

Enroll multiple tools by repeating --tool on swamp repo init. Each tool's scaffolding is written independently, so AGENTS.md and another tool's instructions file (such as CLAUDE.md) coexist in the same repository.

$ swamp repo init --tool codex --tool claude

To enroll an additional tool in an existing repository, run swamp repo upgrade with the full intended list — upgrade replaces the enrolled tools, so any tool you want to keep must appear in the command:

$ swamp repo upgrade --tool codex --tool claude

Verify it works

Open Codex in your repository and invoke the getting-started skill:

$swamp-getting-started

The agent loads the skill and walks you through creating your first model.

Upgrading

When a new version of swamp is released, upgrade the repository to get updated skills and instructions:

$ swamp repo upgrade

The managed section in AGENTS.md is replaced with the latest content. Anything you wrote outside the managed section is preserved.