mirror of
https://github.com/obra/superpowers.git
synced 2026-04-28 20:59:05 +08:00
Compare commits
1 Commits
codex/pri-
...
codex/pri-
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
57aa869f53 |
67
.codex/INSTALL.md
Normal file
67
.codex/INSTALL.md
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
# Installing Superpowers for Codex
|
||||||
|
|
||||||
|
Enable superpowers skills in Codex via native skill discovery. Just clone and symlink.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- Git
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
1. **Clone the superpowers repository:**
|
||||||
|
```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
|
||||||
|
```
|
||||||
|
|
||||||
|
**Windows (PowerShell):**
|
||||||
|
```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"
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Restart Codex** (quit and relaunch the CLI) to discover the skills.
|
||||||
|
|
||||||
|
## Migrating from old bootstrap
|
||||||
|
|
||||||
|
If you installed superpowers before native skill discovery, you need to:
|
||||||
|
|
||||||
|
1. **Update the repo:**
|
||||||
|
```bash
|
||||||
|
cd ~/.codex/superpowers && git pull
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Create the skills symlink** (step 2 above) — this is the new discovery mechanism.
|
||||||
|
|
||||||
|
3. **Remove the old bootstrap block** from `~/.codex/AGENTS.md` — any block referencing `superpowers-codex bootstrap` is no longer needed.
|
||||||
|
|
||||||
|
4. **Restart Codex.**
|
||||||
|
|
||||||
|
## Verify
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ls -la ~/.agents/skills/superpowers
|
||||||
|
```
|
||||||
|
|
||||||
|
You should see a symlink (or junction on Windows) pointing to your superpowers skills directory.
|
||||||
|
|
||||||
|
## Updating
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd ~/.codex/superpowers && git pull
|
||||||
|
```
|
||||||
|
|
||||||
|
Skills update instantly through the symlink.
|
||||||
|
|
||||||
|
## Uninstalling
|
||||||
|
|
||||||
|
```bash
|
||||||
|
rm ~/.agents/skills/superpowers
|
||||||
|
```
|
||||||
|
|
||||||
|
Optionally delete the clone: `rm -rf ~/.codex/superpowers`.
|
||||||
@@ -14,10 +14,14 @@ Add superpowers to the `plugin` array in your `opencode.json` (global or project
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Restart OpenCode. That's it — the plugin auto-installs and registers all skills.
|
Restart OpenCode. The plugin installs through OpenCode's plugin manager and
|
||||||
|
registers all skills.
|
||||||
|
|
||||||
Verify by asking: "Tell me about your superpowers"
|
Verify by asking: "Tell me about your superpowers"
|
||||||
|
|
||||||
|
OpenCode uses its own plugin install. If you also use Claude Code, Codex, or
|
||||||
|
another harness, install Superpowers separately for each one.
|
||||||
|
|
||||||
## Migrating from the old symlink-based install
|
## Migrating from the old symlink-based install
|
||||||
|
|
||||||
If you previously installed superpowers using `git clone` and symlinks, remove the old setup:
|
If you previously installed superpowers using `git clone` and symlinks, remove the old setup:
|
||||||
@@ -46,7 +50,10 @@ use skill tool to load superpowers/brainstorming
|
|||||||
|
|
||||||
## Updating
|
## Updating
|
||||||
|
|
||||||
Superpowers updates automatically when you restart OpenCode.
|
OpenCode installs Superpowers through a git-backed package spec. Some OpenCode
|
||||||
|
and Bun versions pin that resolved git dependency in a lockfile or cache, so a
|
||||||
|
restart may not pick up the newest Superpowers commit. If updates do not appear,
|
||||||
|
clear OpenCode's package cache or reinstall the plugin.
|
||||||
|
|
||||||
To pin a specific version:
|
To pin a specific version:
|
||||||
|
|
||||||
@@ -64,6 +71,26 @@ To pin a specific version:
|
|||||||
2. Verify the plugin line in your `opencode.json`
|
2. Verify the plugin line in your `opencode.json`
|
||||||
3. Make sure you're running a recent version of OpenCode
|
3. Make sure you're running a recent version of OpenCode
|
||||||
|
|
||||||
|
### Windows install issues
|
||||||
|
|
||||||
|
Some Windows OpenCode builds have upstream installer issues with git-backed
|
||||||
|
plugin specs, including cache paths for `git+https` URLs and Bun not finding
|
||||||
|
`git.exe` even when it works in a normal terminal. If OpenCode cannot install
|
||||||
|
the plugin, try installing with system npm and pointing OpenCode at the local
|
||||||
|
package:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
npm install superpowers@git+https://github.com/obra/superpowers.git --prefix "$HOME\.config\opencode"
|
||||||
|
```
|
||||||
|
|
||||||
|
Then use the installed package path in `opencode.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"plugin": ["~/.config/opencode/node_modules/superpowers"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Skills not found
|
### Skills not found
|
||||||
|
|
||||||
1. Use `skill` tool to list what's discovered
|
1. Use `skill` tool to list what's discovered
|
||||||
|
|||||||
@@ -89,6 +89,9 @@ or search for "superpowers" in the plugin marketplace.
|
|||||||
|
|
||||||
### OpenCode
|
### OpenCode
|
||||||
|
|
||||||
|
OpenCode uses its own plugin install; install Superpowers separately even if you
|
||||||
|
already use it in another harness.
|
||||||
|
|
||||||
Tell OpenCode:
|
Tell OpenCode:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|||||||
126
docs/README.codex.md
Normal file
126
docs/README.codex.md
Normal file
@@ -0,0 +1,126 @@
|
|||||||
|
# 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
|
||||||
@@ -12,10 +12,14 @@ Add superpowers to the `plugin` array in your `opencode.json` (global or project
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Restart OpenCode. The plugin auto-installs via Bun and registers all skills automatically.
|
Restart OpenCode. The plugin installs through OpenCode's plugin manager and
|
||||||
|
registers all skills.
|
||||||
|
|
||||||
Verify by asking: "Tell me about your superpowers"
|
Verify by asking: "Tell me about your superpowers"
|
||||||
|
|
||||||
|
OpenCode uses its own plugin install. If you also use Claude Code, Codex, or
|
||||||
|
another harness, install Superpowers separately for each one.
|
||||||
|
|
||||||
### Migrating from the old symlink-based install
|
### Migrating from the old symlink-based install
|
||||||
|
|
||||||
If you previously installed superpowers using `git clone` and symlinks, remove the old setup:
|
If you previously installed superpowers using `git clone` and symlinks, remove the old setup:
|
||||||
@@ -78,7 +82,10 @@ Create project-specific skills in `.opencode/skills/` within your project.
|
|||||||
|
|
||||||
## Updating
|
## Updating
|
||||||
|
|
||||||
Superpowers updates automatically when you restart OpenCode. The plugin is re-installed from the git repository on each launch.
|
OpenCode installs Superpowers through a git-backed package spec. Some OpenCode
|
||||||
|
and Bun versions pin that resolved git dependency in a lockfile or cache, so a
|
||||||
|
restart may not pick up the newest Superpowers commit. If updates do not appear,
|
||||||
|
clear OpenCode's package cache or reinstall the plugin.
|
||||||
|
|
||||||
To pin a specific version, use a branch or tag:
|
To pin a specific version, use a branch or tag:
|
||||||
|
|
||||||
@@ -112,6 +119,26 @@ Skills written for Claude Code are automatically adapted for OpenCode:
|
|||||||
2. Verify the plugin line in your `opencode.json` is correct
|
2. Verify the plugin line in your `opencode.json` is correct
|
||||||
3. Make sure you're running a recent version of OpenCode
|
3. Make sure you're running a recent version of OpenCode
|
||||||
|
|
||||||
|
### Windows install issues
|
||||||
|
|
||||||
|
Some Windows OpenCode builds have upstream installer issues with git-backed
|
||||||
|
plugin specs, including cache paths for `git+https` URLs and Bun not finding
|
||||||
|
`git.exe` even when it works in a normal terminal. If OpenCode cannot install
|
||||||
|
the plugin, try installing with system npm and pointing OpenCode at the local
|
||||||
|
package:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
npm install superpowers@git+https://github.com/obra/superpowers.git --prefix "$HOME\.config\opencode"
|
||||||
|
```
|
||||||
|
|
||||||
|
Then use the installed package path in `opencode.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"plugin": ["~/.config/opencode/node_modules/superpowers"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Skills not found
|
### Skills not found
|
||||||
|
|
||||||
1. Use OpenCode's `skill` tool to list available skills
|
1. Use OpenCode's `skill` tool to list available skills
|
||||||
|
|||||||
@@ -65,11 +65,10 @@ specified in the instructions above.
|
|||||||
|
|
||||||
### When this workaround can be removed
|
### When this workaround can be removed
|
||||||
|
|
||||||
This approach compensates for Codex not yet exposing plugin-packaged custom
|
This approach compensates for Codex's plugin system not yet supporting an `agents`
|
||||||
agents as named `spawn_agent` targets. OpenAI plugin examples can include
|
field in `plugin.json`. When `RawPluginManifest` gains an `agents` field, the
|
||||||
plugin-level `agents/` directories, but skills still need to read those prompts
|
plugin can symlink to `agents/` (mirroring the existing `skills/` symlink) and
|
||||||
and spawn a built-in agent role. When Codex exposes plugin agents as callable
|
skills can dispatch named agent types directly.
|
||||||
named agent types, this manual prompt-loading workaround can be removed.
|
|
||||||
|
|
||||||
## Environment Detection
|
## Environment Detection
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user