Skip to content

docs: correct the csp --agent list in CLAUDE.md#79

Merged
amondnet merged 2 commits into
mainfrom
amondnet/fix-agent-list-doc
Jul 11, 2026
Merged

docs: correct the csp --agent list in CLAUDE.md#79
amondnet merged 2 commits into
mainfrom
amondnet/fix-agent-list-doc

Conversation

@amondnet

@amondnet amondnet commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

Closes #76.

Finding

The reported drift was not in the README — its csp init --agent examples already match the implementation. The stale list lived in CLAUDE.md line 64 (Public API surface):

--agent <claude|cursor|codex|opencode|copilot|kiro|gemini>

This is wrong two ways vs. the actual Agent clap ValueEnum (src/bin/csp/main.rs):

  1. codex is not a valid --agent value — clap rejects it. Codex is supported via the plugin (codex plugin add csp@pleaseai) and MCP (~/.codex/config.toml), not an init-generated agent file.
  2. It omits csp's own agents: antigravity, commandcode, kiro, pi, reasonix.

Decision on codex / zcode (semble#207 / #218)

No new init agents added. Codex is deliberately handled through the plugin/MCP path, so an --agent codex init file would be redundant; zcode is an upstream-installer harness not relevant to csp's deliberately-divergent agent set. The fix is therefore docs-only.

Change

Sync CLAUDE.md's --agent list to the real 10-variant enum and note the Codex distinction.

No code / tests affected.


Summary by cubic

Updated CLAUDE.md to sync the csp --agent options with the current Agent clap ValueEnum. Removed codex (configured via plugin/MCP, not an init agent) and listed all supported agents: claude, gemini, cursor, opencode, copilot, kiro, antigravity, commandcode, pi, reasonix.

Written for commit 9380337. Summary will update on new commits.

The Public API surface listed `--agent <claude|cursor|codex|opencode|
copilot|kiro|gemini>`, which drifted from the actual `Agent` clap
ValueEnum in src/bin/csp/main.rs on two counts:

- it advertised `codex`, which is NOT a valid `--agent` value (clap
  rejects it) — Codex is supported via the plugin / MCP
  `~/.codex/config.toml`, not an `init`-generated agent file;
- it omitted csp's own agents: antigravity, commandcode, kiro, pi,
  reasonix.

Sync the list to the real enum and note the Codex distinction. The
README's `csp init --agent` examples were already correct.

Refs #76

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation in CLAUDE.md to list the correct supported agents for the CLI's --agent flag and clarifies that Codex is not configured as an init agent. There are no review comments, and I have no feedback to provide.

@greptile-apps

greptile-apps Bot commented Jul 11, 2026

Copy link
Copy Markdown

Greptile Summary

This is a docs-only fix that syncs the --agent flag description in CLAUDE.md with the actual Agent clap ValueEnum defined in crates/csp/src/bin/csp/main.rs. The old text listed seven variants (including the invalid codex) and omitted four real ones; the new text lists all ten correct variants and adds an inline note explaining why codex is handled via the plugin/MCP path instead.

  • Removed invalid variant codex; added missing variants antigravity, commandcode, pi, and reasonix to bring the documented set to all 10 real enum values.
  • Corrected the inline source-code path citation from src/bin/csp/main.rs to crates/csp/src/bin/csp/main.rs.

Confidence Score: 5/5

Safe to merge — docs-only change with no code, tests, or logic affected.

The single changed line in CLAUDE.md now accurately reflects all 10 variants of the Agent ValueEnum in crates/csp/src/bin/csp/main.rs, removes the non-existent codex variant, and corrects the inline file path. No executable code is touched.

No files require special attention.

Important Files Changed

Filename Overview
CLAUDE.md Single-line correction to the --agent flag's valid values, removing the invalid codex variant and adding the four previously missing agents (antigravity, commandcode, pi, reasonix); also updates the inline source-code reference path from src/bin/csp/main.rs to the correct crates/csp/src/bin/csp/main.rs.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["csp init --agent <value>"] --> B{Agent ValueEnum}
    B --> C[claude]
    B --> D[gemini]
    B --> E[cursor]
    B --> F[opencode]
    B --> G[copilot]
    B --> H[kiro]
    B --> I[antigravity]
    B --> J[commandcode]
    B --> K[pi]
    B --> L[reasonix]
    M["Codex (not an init agent)"] --> N[Plugin path]
    N --> O["codex plugin add csp@pleaseai"]
    N --> P["~/.codex/config.toml (MCP)"]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A["csp init --agent <value>"] --> B{Agent ValueEnum}
    B --> C[claude]
    B --> D[gemini]
    B --> E[cursor]
    B --> F[opencode]
    B --> G[copilot]
    B --> H[kiro]
    B --> I[antigravity]
    B --> J[commandcode]
    B --> K[pi]
    B --> L[reasonix]
    M["Codex (not an init agent)"] --> N[Plugin path]
    N --> O["codex plugin add csp@pleaseai"]
    N --> P["~/.codex/config.toml (MCP)"]
Loading

Reviews (2): Last reviewed commit: "chore: apply AI code review suggestions" | Re-trigger Greptile

Comment thread CLAUDE.md Outdated
@codecov

codecov Bot commented Jul 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@codspeed-hq

codspeed-hq Bot commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

Merging this PR will not alter performance

✅ 5 untouched benchmarks


Comparing amondnet/fix-agent-list-doc (9380337) with main (74911c9)

Open in CodSpeed

@sonarqubecloud

Copy link
Copy Markdown

@amondnet amondnet merged commit 39cebd4 into main Jul 11, 2026
12 checks passed
@amondnet amondnet deleted the amondnet/fix-agent-list-doc branch July 11, 2026 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs/agents: reconcile --agent codex drift; decide codex(#207)/zcode(#218) support

1 participant