Skip to content

.opencode/INSTALL.md

.opencode/INSTALL.md · 5.3 KB · View on GitHub at 22f0b46

OpenCode V2 requires version 2.0.4 or later.

Use the existing V1 plugin configuration:

{
"plugin": ["superpowers@git+https://github.com/obra/superpowers.git"]
}

Use the V2 plugin configuration:

{
"plugins": ["superpowers@git+https://github.com/obra/superpowers.git"]
}

For a local V2 installation, configure the repository directory containing index.js. OpenCode 2.0.4 and 2.0.7 reject a configured direct JavaScript-file path. Discovered plugin symlinks remain supported.

Restart OpenCode. V2 uses the opencode command; opencode2 may be available as an alias. The plugin installs through OpenCode’s plugin manager and registers all skills.

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.

Section titled “Migrating from the old symlink-based install”

If you previously installed superpowers using git clone and symlinks, remove the old setup:

Terminal window
# Remove old symlinks
rm -f ~/.config/opencode/plugins/superpowers.js
rm -rf ~/.config/opencode/skills/superpowers
# Optionally remove the cloned repo
rm -rf ~/.config/opencode/superpowers
# Remove skills.paths from opencode.json if you added one for superpowers

Then follow the installation steps above.

Use OpenCode’s native skill tool:

use skill tool to list skills
use skill tool to load brainstorming

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, add a tag or commit to the spec (same form for the V1 plugin key and the V2 plugins key):

{
"plugin": ["superpowers@git+https://github.com/obra/superpowers.git#v7.0.2"]
}

On V2, pin v6.4.1 or later; v6.3.0 and earlier releases load only on V1.

  1. Check logs. V1: opencode run --print-logs "hello" 2>&1 | grep -i superpowers. V2 loads plugins in the background server, so add --standalone: opencode run --standalone --print-logs "hello" 2>&1 | grep -i superpowers, or inspect ~/.local/share/opencode/log/opencode.log filtering for role=server.
  2. Verify the plugin line in your opencode.json
  3. Make sure you’re running a recent version of OpenCode

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:

Terminal window
npm install superpowers@git+https://github.com/obra/superpowers.git --prefix "$HOME\.config\opencode"

Then use the absolute path of the installed package in opencode.json for your OpenCode version. OpenCode does not expand ~; a ~/... entry is treated as a package name, not a local directory.

V1:

{
"plugin": ["C:\\Users\\<you>\\.config\\opencode\\node_modules\\superpowers"]
}

V2 (2.0.4 or later):

{
"plugins": ["C:\\Users\\<you>\\.config\\opencode\\node_modules\\superpowers"]
}
  1. Use skill tool to list what’s discovered
  2. Check that the plugin is loading (see above)

Skills speak in actions (“create a todo”, “dispatch a subagent”, “read a file”). The plugin injects a flavor-specific mapping — check your OpenCode version:

V1 (opencode 1.x):

  • “Create a todo” / “mark complete in todo list” → todowrite
  • Subagent (general-purpose): template → task tool with subagent_type: "general" (or "explore" for codebase exploration)
  • “Invoke a skill” → OpenCode’s native skill tool
  • “Read a file” → read
  • “Create a file” / “edit a file” / “delete a file” → apply_patch
  • “Run a shell command” → bash
  • “Search file contents” / “find files by name” → grep, glob
  • “Fetch a URL” → webfetch

V2 (opencode 2.0.4 or later; opencode2 may be available as an alias):

  • “Create a todo” → V2 has no todo tool; track the plan in a markdown file instead
  • Subagent (general-purpose): template → subagent tool with agent: "general" (or "explore"); pass sessionID to continue a previous subagent
  • “Invoke a skill” → OpenCode’s native skill tool
  • “Read a file” → read
  • “Create, edit, or delete files” → use patch with patchText when available; otherwise use write to create or overwrite files, edit for targeted changes, and shell for deletion
  • “Run a shell command” → shell (command, workdir, timeout, background)
  • “Search file contents” / “find files by name” → grep, glob
  • “Fetch a URL” → webfetch
  • “Search the web” → websearch
Original Markdown source
.opencode/INSTALL.md
# Installing Superpowers for OpenCode
## Prerequisites
- [OpenCode.ai](https://opencode.ai) installed
## Installation
OpenCode V2 requires version 2.0.4 or later.
### OpenCode V1
Use the existing V1 plugin configuration:
```json
{
"plugin": ["superpowers@git+https://github.com/obra/superpowers.git"]
}
```
### OpenCode V2 (2.0.4 or later)
Use the V2 plugin configuration:
```json
{
"plugins": ["superpowers@git+https://github.com/obra/superpowers.git"]
}
```
For a local V2 installation, configure the repository directory containing
`index.js`. OpenCode 2.0.4 and 2.0.7 reject a configured direct JavaScript-file
path. Discovered plugin symlinks remain supported.
Restart OpenCode. V2 uses the `opencode` command; `opencode2` may be available
as an alias. The plugin installs through OpenCode's plugin manager and
registers all skills.
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
If you previously installed superpowers using `git clone` and symlinks, remove the old setup:
```bash
# Remove old symlinks
rm -f ~/.config/opencode/plugins/superpowers.js
rm -rf ~/.config/opencode/skills/superpowers
# Optionally remove the cloned repo
rm -rf ~/.config/opencode/superpowers
# Remove skills.paths from opencode.json if you added one for superpowers
```
Then follow the installation steps above.
## Usage
Use OpenCode's native `skill` tool:
```
use skill tool to list skills
use skill tool to load brainstorming
```
## Updating
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, add a tag or commit to the spec (same form for the
V1 `plugin` key and the V2 `plugins` key):
```json
{
"plugin": ["superpowers@git+https://github.com/obra/superpowers.git#v7.0.2"]
}
```
On V2, pin `v6.4.1` or later; `v6.3.0` and earlier releases load only on V1.
## Troubleshooting
### Plugin not loading
1. Check logs. V1: `opencode run --print-logs "hello" 2>&1 | grep -i superpowers`.
V2 loads plugins in the background server, so add `--standalone`:
`opencode run --standalone --print-logs "hello" 2>&1 | grep -i superpowers`,
or inspect `~/.local/share/opencode/log/opencode.log` filtering for `role=server`.
2. Verify the plugin line in your `opencode.json`
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 absolute path of the installed package in `opencode.json` for your
OpenCode version. OpenCode does not expand `~`; a `~/...` entry is treated as a
package name, not a local directory.
**V1:**
```json
{
"plugin": ["C:\\Users\\<you>\\.config\\opencode\\node_modules\\superpowers"]
}
```
**V2 (2.0.4 or later):**
```json
{
"plugins": ["C:\\Users\\<you>\\.config\\opencode\\node_modules\\superpowers"]
}
```
### Skills not found
1. Use `skill` tool to list what's discovered
2. Check that the plugin is loading (see above)
### Tool mapping
Skills speak in actions ("create a todo", "dispatch a subagent", "read a file"). The plugin injects a flavor-specific mapping — check your OpenCode version:
**V1 (`opencode` 1.x):**
- "Create a todo" / "mark complete in todo list" → `todowrite`
- `Subagent (general-purpose):` template → `task` tool with `subagent_type: "general"` (or `"explore"` for codebase exploration)
- "Invoke a skill" → OpenCode's native `skill` tool
- "Read a file" → `read`
- "Create a file" / "edit a file" / "delete a file" → `apply_patch`
- "Run a shell command" → `bash`
- "Search file contents" / "find files by name" → `grep`, `glob`
- "Fetch a URL" → `webfetch`
**V2 (`opencode` 2.0.4 or later; `opencode2` may be available as an alias):**
- "Create a todo" → V2 has no todo tool; track the plan in a markdown file instead
- `Subagent (general-purpose):` template → `subagent` tool with `agent: "general"` (or `"explore"`); pass `sessionID` to continue a previous subagent
- "Invoke a skill" → OpenCode's native `skill` tool
- "Read a file" → `read`
- "Create, edit, or delete files" → use `patch` with `patchText` when available; otherwise use `write` to create or overwrite files, `edit` for targeted changes, and `shell` for deletion
- "Run a shell command" → `shell` (`command`, `workdir`, `timeout`, `background`)
- "Search file contents" / "find files by name" → `grep`, `glob`
- "Fetch a URL" → `webfetch`
- "Search the web" → `websearch`
## Getting Help
- Report issues: https://github.com/obra/superpowers/issues
- Full documentation: https://github.com/obra/superpowers/blob/main/docs/README.opencode.md