diff options
| author | Drew Ritter <drew@primeradiant.com> | 2026-04-27 13:57:45 -0700 |
|---|---|---|
| committer | Drew Ritter <drew@primeradiant.com> | 2026-04-28 16:07:22 -0700 |
| commit | 3d7b32ba57417c94cf89f99ba3f21d2d6b350616 (patch) | |
| tree | a1f1a3c97b2b8a7b5e85d97587ff07ba4ad349ff /docs | |
| parent | 772332a4765331f202f5cb87bcbe4e7e1db9deed (diff) | |
docs: update Codex plugin install guidancecodex/pri-1367-codex-install-docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.codex.md | 126 |
1 files changed, 0 insertions, 126 deletions
diff --git a/docs/README.codex.md b/docs/README.codex.md deleted file mode 100644 index 97e2319..0000000 --- a/docs/README.codex.md +++ /dev/null @@ -1,126 +0,0 @@ -# Superpowers for Codex - -Guide for using Superpowers with OpenAI Codex via native skill discovery. - -## Quick Install - -Tell Codex: - -``` -Fetch and follow instructions from https://raw.githubusercontent.com/obra/superpowers/refs/heads/main/.codex/INSTALL.md -``` - -## Manual Installation - -### Prerequisites - -- OpenAI Codex CLI -- Git - -### Steps - -1. Clone the repo: - ```bash - git clone https://github.com/obra/superpowers.git ~/.codex/superpowers - ``` - -2. Create the skills symlink: - ```bash - mkdir -p ~/.agents/skills - ln -s ~/.codex/superpowers/skills ~/.agents/skills/superpowers - ``` - -3. Restart Codex. - -4. **For subagent skills** (optional): Skills like `dispatching-parallel-agents` and `subagent-driven-development` require Codex's multi-agent feature. Add to your Codex config: - ```toml - [features] - multi_agent = true - ``` - -### Windows - -Use a junction instead of a symlink (works without Developer Mode): - -```powershell -New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.agents\skills" -cmd /c mklink /J "$env:USERPROFILE\.agents\skills\superpowers" "$env:USERPROFILE\.codex\superpowers\skills" -``` - -## How It Works - -Codex has native skill discovery — it scans `~/.agents/skills/` at startup, parses SKILL.md frontmatter, and loads skills on demand. Superpowers skills are made visible through a single symlink: - -``` -~/.agents/skills/superpowers/ → ~/.codex/superpowers/skills/ -``` - -The `using-superpowers` skill is discovered automatically and enforces skill usage discipline — no additional configuration needed. - -## Usage - -Skills are discovered automatically. Codex activates them when: -- You mention a skill by name (e.g., "use brainstorming") -- The task matches a skill's description -- The `using-superpowers` skill directs Codex to use one - -### Personal Skills - -Create your own skills in `~/.agents/skills/`: - -```bash -mkdir -p ~/.agents/skills/my-skill -``` - -Create `~/.agents/skills/my-skill/SKILL.md`: - -```markdown ---- -name: my-skill -description: Use when [condition] - [what it does] ---- - -# My Skill - -[Your skill content here] -``` - -The `description` field is how Codex decides when to activate a skill automatically — write it as a clear trigger condition. - -## Updating - -```bash -cd ~/.codex/superpowers && git pull -``` - -Skills update instantly through the symlink. - -## Uninstalling - -```bash -rm ~/.agents/skills/superpowers -``` - -**Windows (PowerShell):** -```powershell -Remove-Item "$env:USERPROFILE\.agents\skills\superpowers" -``` - -Optionally delete the clone: `rm -rf ~/.codex/superpowers` (Windows: `Remove-Item -Recurse -Force "$env:USERPROFILE\.codex\superpowers"`). - -## Troubleshooting - -### Skills not showing up - -1. Verify the symlink: `ls -la ~/.agents/skills/superpowers` -2. Check skills exist: `ls ~/.codex/superpowers/skills` -3. Restart Codex — skills are discovered at startup - -### Windows junction issues - -Junctions normally work without special permissions. If creation fails, try running PowerShell as administrator. - -## Getting Help - -- Report issues: https://github.com/obra/superpowers/issues -- Main documentation: https://github.com/obra/superpowers |
