From 5745f0ea9937ffb686ebc9c4c5324dca9a643952 Mon Sep 17 00:00:00 2001 From: Drew Ritter Date: Tue, 28 Apr 2026 09:41:24 -0700 Subject: [PATCH] docs: add README quickstart install links (#1293) --- README.md | 148 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 83 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index 4a5589ae..ea17e30e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ Superpowers is a complete software development methodology for your coding agents, built on top of a set of composable skills and some initial instructions that make sure your agent uses them. +## Quickstart + +Give your agent Superpowers: [Claude Code](#claude-code), [Codex CLI](#codex-cli), [Codex App](#codex-app), [Factory Droid](#factory-droid), [Gemini CLI](#gemini-cli), [OpenCode](#opencode), [Cursor](#cursor), [GitHub Copilot CLI](#github-copilot-cli). + ## How it works It starts from the moment you fire up your coding agent. As soon as it sees that you're building something, it *doesn't* just jump into trying to write code. Instead, it steps back and asks you what you're really trying to do. @@ -26,112 +30,126 @@ Thanks! ## Installation -**Note:** Installation differs by platform. +Installation differs by harness. If you use more than one, install Superpowers separately for each one. -### Claude Code Official Marketplace +### Claude Code Superpowers is available via the [official Claude plugin marketplace](https://claude.com/plugins/superpowers) -Install the plugin from Anthropic's official marketplace: +#### Official Marketplace -```bash -/plugin install superpowers@claude-plugins-official -``` +- Install the plugin from Anthropic's official marketplace: -### Claude Code (Superpowers Marketplace) + ```bash + /plugin install superpowers@claude-plugins-official + ``` + +#### Superpowers Marketplace The Superpowers marketplace provides Superpowers and some other related plugins for Claude Code. -In Claude Code, register the marketplace first: +- Register the marketplace: -```bash -/plugin marketplace add obra/superpowers-marketplace -``` + ```bash + /plugin marketplace add obra/superpowers-marketplace + ``` -Then install the plugin from this marketplace: +- Install the plugin from this marketplace: -```bash -/plugin install superpowers@superpowers-marketplace -``` + ```bash + /plugin install superpowers@superpowers-marketplace + ``` -### OpenAI Codex CLI +### Codex CLI -- Open plugin search interface +Superpowers is available via the [official Codex plugin marketplace](https://github.com/openai/plugins). -```bash -/plugins -``` +- Open the plugin search interface: -Search for Superpowers + ```bash + /plugins + ``` -```bash -superpowers -``` +- Search for Superpowers: -Select `Install Plugin` + ```bash + superpowers + ``` -### OpenAI Codex App +- Select `Install Plugin`. + +### Codex App + +Superpowers is available via the [official Codex plugin marketplace](https://github.com/openai/plugins). - In the Codex app, click on Plugins in the sidebar. -- You should see `Superpowers` in the Coding section. +- You should see `Superpowers` in the Coding section. - Click the `+` next to Superpowers and follow the prompts. +### Factory Droid -### Cursor (via Plugin Marketplace) +- Register the marketplace: -In Cursor Agent chat, install from marketplace: + ```bash + droid plugin marketplace add https://github.com/obra/superpowers + ``` -```text -/add-plugin superpowers -``` +- Install the plugin: -or search for "superpowers" in the plugin marketplace. + ```bash + droid plugin install superpowers@superpowers + ``` + +### Gemini CLI + +- Install the extension: + + ```bash + gemini extensions install https://github.com/obra/superpowers + ``` + +- Update later: + + ```bash + gemini extensions update superpowers + ``` ### OpenCode OpenCode uses its own plugin install; install Superpowers separately even if you already use it in another harness. -Tell OpenCode: +- Tell OpenCode: -``` -Fetch and follow instructions from https://raw.githubusercontent.com/obra/superpowers/refs/heads/main/.opencode/INSTALL.md -``` + ``` + Fetch and follow instructions from https://raw.githubusercontent.com/obra/superpowers/refs/heads/main/.opencode/INSTALL.md + ``` -**Detailed docs:** [docs/README.opencode.md](docs/README.opencode.md) +- Detailed docs: [docs/README.opencode.md](docs/README.opencode.md) + +### Cursor + +- In Cursor Agent chat, install from marketplace: + + ```text + /add-plugin superpowers + ``` + +- Or search for "superpowers" in the plugin marketplace. ### GitHub Copilot CLI -```bash -copilot plugin marketplace add obra/superpowers-marketplace -copilot plugin install superpowers@superpowers-marketplace -``` +- Register the marketplace: -### Gemini CLI + ```bash + copilot plugin marketplace add obra/superpowers-marketplace + ``` -```bash -gemini extensions install https://github.com/obra/superpowers -``` +- Install the plugin: -To update: - -```bash -gemini extensions update superpowers -``` - -### Factory Droid - -In Droid, register the marketplace: - -```bash -droid plugin marketplace add https://github.com/obra/superpowers -``` - -Then install: - -```bash -droid plugin install superpowers@superpowers -``` + ```bash + copilot plugin install superpowers@superpowers-marketplace + ``` ## The Basic Workflow