Repository navigation
docs(setup): correct Codex plugin installation instructions - #1556
Merged
Merged
Conversation
Use the supported add subcommand with explicit marketplace selectors. The bare plugin names still fail after changing the verb, and the Codex catalogue does not offer the agent-guard plugin shown in the baseline. Update the companion registry and generated page together so regeneration keeps the corrected Superpowers installation command. Generated-by: Codex (codex-cli 0.159.0-alpha.12.1)
potiuk
approved these changes
Oct 8, 2026
potiuk
left a comment
Member
There was a problem hiding this comment.
LGTM — the Codex install commands now match the real CLI, and CI is green.
Checked:
codex plugin addexists andcodex plugin installdoes not, so the old commands were wrong.magpie-agent-guardis not in.agents/plugins/marketplace.json, so dropping it from the Codex block is correct.- No other doc or config still uses
codex plugin install.
This review was drafted by an AI-assisted tool and
confirmed by an Apache Magpie maintainer. The maintainer
approving this PR has read the findings and signed off. If
something feels off, please reply on the PR and a maintainer
will follow up.More on how Apache Magpie handles maintainer review:
Contributing guide.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
plugin installexamples withplugin addand explicit marketplace selectors so the commands reach installation.Type of change
.claude/skills/<name>/) — eval fixtures updated belowtools/<system>/*.md)tools/*/withpyproject.toml)docs/,README.md,CONTRIBUTING.md)projects/_template/)prek, workflows, validators)tools/dev/companion-skills.json.Test plan
prek run --all-filespasses in the Linux validation copy, including workspace pytest, ruff and mypy;prek run lychee --all-filesalso passes (both exit 0).uv run pytest/ruff check/mypypasses — not applicable; no Python implementation changes.git diff --checkand the companion generator's consistency check pass; regenerating the page again produces no additional diff after preserving LF line endings on Windows.plugin install --helpreturns 2; unqualifiedplugin add magpie-setupreturns 1; qualified agent-guard add returns 1 because no such catalogue entry exists.plugin add ... --help; no third-party plugin installation was performed.RFC-AI-0004 compliance
The change corrects installation examples and command data.
It introduces no new mutation policy, adapter, sandbox access, or skill workflow; the principle-specific rows below are not applicable.
<PROJECT>,<tracker>,<upstream>,<security-list>) used in all skill / tool proseLinked issues
Closes #1555.
Notes for reviewers (optional)
Validation uses upstream commit
f3cab5ce60319da987549a8523ac1226885f1ae7and the same staged Git tree in a Linux container to preserve repository symlinks.The first whole-tree run exposed missing container prerequisites (
jq,gh, tokenizer cache) and a process-reaping requirement.After preparing those prerequisites and running under
tini, the complete hook run and the separate link check both passed.Only the three contribution files belong in this PR.
Local reproduction logs, review materials and validation scripts are kept outside the repository checkout.
Suggested labels:
family:setup,family:docs,capability:platform.Generative AI disclosure: Codex assisted with the documentation correction, verification, and preparation of this PR description.
The contributor will review the complete diff and submission text before publication.