|
|
@@ -7,7 +7,7 @@ Complete guide for using Superpowers with [OpenCode.ai](https://opencode.ai).
|
|
|
Tell OpenCode:
|
|
|
|
|
|
```
|
|
|
-Clone https://github.com/obra/superpowers to ~/.config/opencode/superpowers, then create directory ~/.config/opencode/plugin, then symlink ~/.config/opencode/superpowers/.opencode/plugin/superpowers.js to ~/.config/opencode/plugin/superpowers.js, then restart opencode.
|
|
|
+Clone https://github.com/obra/superpowers to ~/.config/opencode/superpowers, then create directory ~/.config/opencode/plugin, then symlink ~/.config/opencode/superpowers/.opencode/plugin/superpowers.js to ~/.config/opencode/plugin/superpowers.js, then symlink ~/.config/opencode/superpowers/skills to ~/.config/opencode/skills/superpowers, then restart opencode.
|
|
|
```
|
|
|
|
|
|
## Manual Installation
|
|
|
@@ -15,59 +15,171 @@ Clone https://github.com/obra/superpowers to ~/.config/opencode/superpowers, the
|
|
|
### Prerequisites
|
|
|
|
|
|
- [OpenCode.ai](https://opencode.ai) installed
|
|
|
-- Node.js installed
|
|
|
- Git installed
|
|
|
|
|
|
-### Installation Steps
|
|
|
+### macOS / Linux
|
|
|
|
|
|
-#### 1. Install Superpowers
|
|
|
+```bash
|
|
|
+# 1. Install Superpowers (or update existing)
|
|
|
+if [ -d ~/.config/opencode/superpowers ]; then
|
|
|
+ cd ~/.config/opencode/superpowers && git pull
|
|
|
+else
|
|
|
+ git clone https://github.com/obra/superpowers.git ~/.config/opencode/superpowers
|
|
|
+fi
|
|
|
+
|
|
|
+# 2. Create directories
|
|
|
+mkdir -p ~/.config/opencode/plugin ~/.config/opencode/skills
|
|
|
+
|
|
|
+# 3. Create symlinks (safe for reinstalls - ln -sf overwrites)
|
|
|
+ln -sf ~/.config/opencode/superpowers/.opencode/plugin/superpowers.js ~/.config/opencode/plugin/superpowers.js
|
|
|
+ln -sf ~/.config/opencode/superpowers/skills ~/.config/opencode/skills/superpowers
|
|
|
+
|
|
|
+# 4. Restart OpenCode
|
|
|
+```
|
|
|
+
|
|
|
+#### Verify Installation
|
|
|
|
|
|
```bash
|
|
|
-mkdir -p ~/.config/opencode/superpowers
|
|
|
-git clone https://github.com/obra/superpowers.git ~/.config/opencode/superpowers
|
|
|
+ls -l ~/.config/opencode/plugin/superpowers.js
|
|
|
+ls -l ~/.config/opencode/skills/superpowers
|
|
|
```
|
|
|
|
|
|
-#### 2. Register the Plugin
|
|
|
+Both should show symlinks pointing to the superpowers directory.
|
|
|
|
|
|
-OpenCode discovers plugins from `~/.config/opencode/plugin/`. Create a symlink:
|
|
|
+### Windows
|
|
|
|
|
|
-```bash
|
|
|
-mkdir -p ~/.config/opencode/plugin
|
|
|
-ln -sf ~/.config/opencode/superpowers/.opencode/plugin/superpowers.js ~/.config/opencode/plugin/superpowers.js
|
|
|
+**Prerequisites:**
|
|
|
+- Git installed
|
|
|
+- Either **Developer Mode** enabled OR **Administrator privileges**
|
|
|
+ - Windows 10: Settings → Update & Security → For developers
|
|
|
+ - Windows 11: Settings → System → For developers
|
|
|
+
|
|
|
+Pick your shell below: [Command Prompt](#command-prompt) | [PowerShell](#powershell) | [Git Bash](#git-bash)
|
|
|
+
|
|
|
+#### Command Prompt
|
|
|
+
|
|
|
+Run as Administrator, or with Developer Mode enabled:
|
|
|
+
|
|
|
+```cmd
|
|
|
+:: 1. Install Superpowers
|
|
|
+git clone https://github.com/obra/superpowers.git "%USERPROFILE%\.config\opencode\superpowers"
|
|
|
+
|
|
|
+:: 2. Create directories
|
|
|
+mkdir "%USERPROFILE%\.config\opencode\plugin" 2>nul
|
|
|
+mkdir "%USERPROFILE%\.config\opencode\skills" 2>nul
|
|
|
+
|
|
|
+:: 3. Remove existing links (safe for reinstalls)
|
|
|
+del "%USERPROFILE%\.config\opencode\plugin\superpowers.js" 2>nul
|
|
|
+rmdir "%USERPROFILE%\.config\opencode\skills\superpowers" 2>nul
|
|
|
+
|
|
|
+:: 4. Create plugin symlink (requires Developer Mode or Admin)
|
|
|
+mklink "%USERPROFILE%\.config\opencode\plugin\superpowers.js" "%USERPROFILE%\.config\opencode\superpowers\.opencode\plugin\superpowers.js"
|
|
|
+
|
|
|
+:: 5. Create skills junction (works without special privileges)
|
|
|
+mklink /J "%USERPROFILE%\.config\opencode\skills\superpowers" "%USERPROFILE%\.config\opencode\superpowers\skills"
|
|
|
+
|
|
|
+:: 6. Restart OpenCode
|
|
|
```
|
|
|
|
|
|
-Alternatively, for project-local installation:
|
|
|
+#### PowerShell
|
|
|
+
|
|
|
+Run as Administrator, or with Developer Mode enabled:
|
|
|
+
|
|
|
+```powershell
|
|
|
+# 1. Install Superpowers
|
|
|
+git clone https://github.com/obra/superpowers.git "$env:USERPROFILE\.config\opencode\superpowers"
|
|
|
+
|
|
|
+# 2. Create directories
|
|
|
+New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.config\opencode\plugin"
|
|
|
+New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.config\opencode\skills"
|
|
|
+
|
|
|
+# 3. Remove existing links (safe for reinstalls)
|
|
|
+Remove-Item "$env:USERPROFILE\.config\opencode\plugin\superpowers.js" -Force -ErrorAction SilentlyContinue
|
|
|
+Remove-Item "$env:USERPROFILE\.config\opencode\skills\superpowers" -Force -ErrorAction SilentlyContinue
|
|
|
+
|
|
|
+# 4. Create plugin symlink (requires Developer Mode or Admin)
|
|
|
+New-Item -ItemType SymbolicLink -Path "$env:USERPROFILE\.config\opencode\plugin\superpowers.js" -Target "$env:USERPROFILE\.config\opencode\superpowers\.opencode\plugin\superpowers.js"
|
|
|
+
|
|
|
+# 5. Create skills junction (works without special privileges)
|
|
|
+New-Item -ItemType Junction -Path "$env:USERPROFILE\.config\opencode\skills\superpowers" -Target "$env:USERPROFILE\.config\opencode\superpowers\skills"
|
|
|
+
|
|
|
+# 6. Restart OpenCode
|
|
|
+```
|
|
|
+
|
|
|
+#### Git Bash
|
|
|
+
|
|
|
+Note: Git Bash's native `ln` command copies files instead of creating symlinks. Use `cmd //c mklink` instead (the `//c` is Git Bash syntax for `/c`).
|
|
|
|
|
|
```bash
|
|
|
-# In your OpenCode project
|
|
|
-mkdir -p .opencode/plugin
|
|
|
-ln -sf ~/.config/opencode/superpowers/.opencode/plugin/superpowers.js .opencode/plugin/superpowers.js
|
|
|
+# 1. Install Superpowers
|
|
|
+git clone https://github.com/obra/superpowers.git ~/.config/opencode/superpowers
|
|
|
+
|
|
|
+# 2. Create directories
|
|
|
+mkdir -p ~/.config/opencode/plugin ~/.config/opencode/skills
|
|
|
+
|
|
|
+# 3. Remove existing links (safe for reinstalls)
|
|
|
+rm -f ~/.config/opencode/plugin/superpowers.js 2>/dev/null
|
|
|
+rm -rf ~/.config/opencode/skills/superpowers 2>/dev/null
|
|
|
+
|
|
|
+# 4. Create plugin symlink (requires Developer Mode or Admin)
|
|
|
+cmd //c "mklink \"$(cygpath -w ~/.config/opencode/plugin/superpowers.js)\" \"$(cygpath -w ~/.config/opencode/superpowers/.opencode/plugin/superpowers.js)\""
|
|
|
+
|
|
|
+# 5. Create skills junction (works without special privileges)
|
|
|
+cmd //c "mklink /J \"$(cygpath -w ~/.config/opencode/skills/superpowers)\" \"$(cygpath -w ~/.config/opencode/superpowers/skills)\""
|
|
|
+
|
|
|
+# 6. Restart OpenCode
|
|
|
+```
|
|
|
+
|
|
|
+#### WSL Users
|
|
|
+
|
|
|
+If running OpenCode inside WSL, use the [macOS / Linux](#macos--linux) instructions instead.
|
|
|
+
|
|
|
+#### Verify Installation
|
|
|
+
|
|
|
+**Command Prompt:**
|
|
|
+```cmd
|
|
|
+dir /AL "%USERPROFILE%\.config\opencode\plugin"
|
|
|
+dir /AL "%USERPROFILE%\.config\opencode\skills"
|
|
|
+```
|
|
|
+
|
|
|
+**PowerShell:**
|
|
|
+```powershell
|
|
|
+Get-ChildItem "$env:USERPROFILE\.config\opencode\plugin" | Where-Object { $_.LinkType }
|
|
|
+Get-ChildItem "$env:USERPROFILE\.config\opencode\skills" | Where-Object { $_.LinkType }
|
|
|
```
|
|
|
|
|
|
-#### 3. Restart OpenCode
|
|
|
+Look for `<SYMLINK>` or `<JUNCTION>` in the output.
|
|
|
+
|
|
|
+#### Troubleshooting Windows
|
|
|
+
|
|
|
+**"You do not have sufficient privilege" error:**
|
|
|
+- Enable Developer Mode in Windows Settings, OR
|
|
|
+- Right-click your terminal → "Run as Administrator"
|
|
|
+
|
|
|
+**"Cannot create a file when that file already exists":**
|
|
|
+- Run the removal commands (step 3) first, then retry
|
|
|
|
|
|
-Restart OpenCode to load the plugin. Superpowers will automatically activate.
|
|
|
+**Symlinks not working after git clone:**
|
|
|
+- Run `git config --global core.symlinks true` and re-clone
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
### Finding Skills
|
|
|
|
|
|
-Use the `find_skills` tool to list all available skills:
|
|
|
+Use OpenCode's native `skill` tool to list all available skills:
|
|
|
|
|
|
```
|
|
|
-use find_skills tool
|
|
|
+use skill tool to list skills
|
|
|
```
|
|
|
|
|
|
### Loading a Skill
|
|
|
|
|
|
-Use the `use_skill` tool to load a specific skill:
|
|
|
+Use OpenCode's native `skill` tool to load a specific skill:
|
|
|
|
|
|
```
|
|
|
-use use_skill tool with skill_name: "superpowers:brainstorming"
|
|
|
+use skill tool to load superpowers/brainstorming
|
|
|
```
|
|
|
|
|
|
-Skills are automatically inserted into the conversation and persist across context compaction.
|
|
|
-
|
|
|
### Personal Skills
|
|
|
|
|
|
Create your own skills in `~/.config/opencode/skills/`:
|
|
|
@@ -111,40 +223,31 @@ description: Use when [condition] - [what it does]
|
|
|
[Your skill content here]
|
|
|
```
|
|
|
|
|
|
-## Skill Priority
|
|
|
+## Skill Locations
|
|
|
|
|
|
-Skills are resolved with this priority order:
|
|
|
+OpenCode discovers skills from these locations:
|
|
|
|
|
|
1. **Project skills** (`.opencode/skills/`) - Highest priority
|
|
|
2. **Personal skills** (`~/.config/opencode/skills/`)
|
|
|
-3. **Superpowers skills** (`~/.config/opencode/superpowers/skills/`)
|
|
|
-
|
|
|
-You can force resolution to a specific level:
|
|
|
-- `project:skill-name` - Force project skill
|
|
|
-- `skill-name` - Search project → personal → superpowers
|
|
|
-- `superpowers:skill-name` - Force superpowers skill
|
|
|
+3. **Superpowers skills** (`~/.config/opencode/skills/superpowers/`) - via symlink
|
|
|
|
|
|
## Features
|
|
|
|
|
|
### Automatic Context Injection
|
|
|
|
|
|
-The plugin automatically injects superpowers context via the chat.message hook on every session. No manual configuration needed.
|
|
|
-
|
|
|
-### Message Insertion Pattern
|
|
|
+The plugin automatically injects superpowers context via the `experimental.chat.system.transform` hook. This adds the "using-superpowers" skill content to the system prompt on every request.
|
|
|
|
|
|
-When you load a skill with `use_skill`, it's inserted as a user message with `noReply: true`. This ensures skills persist throughout long conversations, even when OpenCode compacts context.
|
|
|
+### Native Skills Integration
|
|
|
|
|
|
-### Compaction Resilience
|
|
|
-
|
|
|
-The plugin listens for `session.compacted` events and automatically re-injects the core superpowers bootstrap to maintain functionality after context compaction.
|
|
|
+Superpowers uses OpenCode's native `skill` tool for skill discovery and loading. Skills are symlinked into `~/.config/opencode/skills/superpowers/` so they appear alongside your personal and project skills.
|
|
|
|
|
|
### Tool Mapping
|
|
|
|
|
|
-Skills written for Claude Code are automatically adapted for OpenCode. The plugin provides mapping instructions:
|
|
|
+Skills written for Claude Code are automatically adapted for OpenCode. The bootstrap provides mapping instructions:
|
|
|
|
|
|
- `TodoWrite` → `update_plan`
|
|
|
- `Task` with subagents → OpenCode's `@mention` system
|
|
|
-- `Skill` tool → `use_skill` custom tool
|
|
|
+- `Skill` tool → OpenCode's native `skill` tool
|
|
|
- File operations → Native OpenCode tools
|
|
|
|
|
|
## Architecture
|
|
|
@@ -154,23 +257,14 @@ Skills written for Claude Code are automatically adapted for OpenCode. The plugi
|
|
|
**Location:** `~/.config/opencode/superpowers/.opencode/plugin/superpowers.js`
|
|
|
|
|
|
**Components:**
|
|
|
-- Two custom tools: `use_skill`, `find_skills`
|
|
|
-- chat.message hook for initial context injection
|
|
|
-- event handler for session.compacted re-injection
|
|
|
-- Uses shared `lib/skills-core.js` module (also used by Codex)
|
|
|
-
|
|
|
-### Shared Core Module
|
|
|
+- `experimental.chat.system.transform` hook for bootstrap injection
|
|
|
+- Reads and injects the "using-superpowers" skill content
|
|
|
|
|
|
-**Location:** `~/.config/opencode/superpowers/lib/skills-core.js`
|
|
|
+### Skills
|
|
|
|
|
|
-**Functions:**
|
|
|
-- `extractFrontmatter()` - Parse skill metadata
|
|
|
-- `stripFrontmatter()` - Remove metadata from content
|
|
|
-- `findSkillsInDir()` - Recursive skill discovery
|
|
|
-- `resolveSkillPath()` - Skill resolution with shadowing
|
|
|
-- `checkForUpdates()` - Git update detection
|
|
|
+**Location:** `~/.config/opencode/skills/superpowers/` (symlink to `~/.config/opencode/superpowers/skills/`)
|
|
|
|
|
|
-This module is shared between OpenCode and Codex implementations for code reuse.
|
|
|
+Skills are discovered by OpenCode's native skill system. Each skill has a `SKILL.md` file with YAML frontmatter.
|
|
|
|
|
|
## Updating
|
|
|
|
|
|
@@ -185,28 +279,28 @@ Restart OpenCode to load the updates.
|
|
|
|
|
|
### Plugin not loading
|
|
|
|
|
|
-1. Check plugin file exists: `ls ~/.config/opencode/superpowers/.opencode/plugin/superpowers.js`
|
|
|
-2. Check symlink: `ls -l ~/.config/opencode/plugin/superpowers.js`
|
|
|
+1. Check plugin exists: `ls ~/.config/opencode/superpowers/.opencode/plugin/superpowers.js`
|
|
|
+2. Check symlink/junction: `ls -l ~/.config/opencode/plugin/` (macOS/Linux) or `dir /AL %USERPROFILE%\.config\opencode\plugin` (Windows)
|
|
|
3. Check OpenCode logs: `opencode run "test" --print-logs --log-level DEBUG`
|
|
|
-4. Look for: `service=plugin path=file:///.../superpowers.js loading plugin`
|
|
|
+4. Look for plugin loading message in logs
|
|
|
|
|
|
### Skills not found
|
|
|
|
|
|
-1. Verify skills directory: `ls ~/.config/opencode/superpowers/skills`
|
|
|
-2. Use `find_skills` tool to see what's discovered
|
|
|
-3. Check skill structure: each skill needs a `SKILL.md` file
|
|
|
+1. Verify skills symlink: `ls -l ~/.config/opencode/skills/superpowers` (should point to superpowers/skills/)
|
|
|
+2. Use OpenCode's `skill` tool to list available skills
|
|
|
+3. Check skill structure: each skill needs a `SKILL.md` file with valid frontmatter
|
|
|
|
|
|
-### Tools not working
|
|
|
+### Windows: Module not found error
|
|
|
|
|
|
-1. Verify plugin loaded: Check OpenCode logs for plugin loading message
|
|
|
-2. Check Node.js version: The plugin requires Node.js for ES modules
|
|
|
-3. Test plugin manually: `node --input-type=module -e "import('file://~/.config/opencode/plugin/superpowers.js').then(m => console.log(Object.keys(m)))"`
|
|
|
+If you see `Cannot find module` errors on Windows:
|
|
|
+- **Cause:** Git Bash `ln -sf` copies files instead of creating symlinks
|
|
|
+- **Fix:** Use `mklink /J` directory junctions instead (see Windows installation steps)
|
|
|
|
|
|
-### Context not injecting
|
|
|
+### Bootstrap not appearing
|
|
|
|
|
|
-1. Check if chat.message hook is working
|
|
|
-2. Verify using-superpowers skill exists
|
|
|
-3. Check OpenCode version (requires recent version with plugin support)
|
|
|
+1. Verify using-superpowers skill exists: `ls ~/.config/opencode/superpowers/skills/using-superpowers/SKILL.md`
|
|
|
+2. Check OpenCode version supports `experimental.chat.system.transform` hook
|
|
|
+3. Restart OpenCode after plugin changes
|
|
|
|
|
|
## Getting Help
|
|
|
|
|
|
@@ -216,19 +310,17 @@ Restart OpenCode to load the updates.
|
|
|
|
|
|
## Testing
|
|
|
|
|
|
-The implementation includes an automated test suite at `tests/opencode/`:
|
|
|
+Verify your installation:
|
|
|
|
|
|
```bash
|
|
|
-# Run all tests
|
|
|
-./tests/opencode/run-tests.sh --integration --verbose
|
|
|
+# Check plugin loads
|
|
|
+opencode run --print-logs "hello" 2>&1 | grep -i superpowers
|
|
|
+
|
|
|
+# Check skills are discoverable
|
|
|
+opencode run "use skill tool to list all skills" 2>&1 | grep -i superpowers
|
|
|
|
|
|
-# Run specific test
|
|
|
-./tests/opencode/run-tests.sh --test test-tools.sh
|
|
|
+# Check bootstrap injection
|
|
|
+opencode run "what superpowers do you have?"
|
|
|
```
|
|
|
|
|
|
-Tests verify:
|
|
|
-- Plugin loading
|
|
|
-- Skills-core library functionality
|
|
|
-- Tool execution (use_skill, find_skills)
|
|
|
-- Skill priority resolution
|
|
|
-- Proper isolation with temp HOME
|
|
|
+The agent should mention having superpowers and be able to list skills from `superpowers/`.
|