Installation
Requirements
Section titled “Requirements”OpenSpec requires Bun as its runtime. Install from bun.sh if you haven’t already.
Install OpenSpec
Section titled “Install OpenSpec”Option 1: Run with bunx (Recommended)
Section titled “Option 1: Run with bunx (Recommended)”bunx @clanker-guru/openspecThis downloads and runs the latest version without global installation.
Option 2: Global Installation
Section titled “Option 2: Global Installation”bun install -g @clanker-guru/openspecVerify:
openspec --versionInitialize in Your Project
Section titled “Initialize in Your Project”cd your-projectopenspec initDuring initialization, you’ll be prompted to select your AI coding tools. OpenSpec supports:
Native Slash Commands
Section titled “Native Slash Commands”These tools get custom /openspec commands:
| Tool | Commands |
|---|---|
| Claude Code | /openspec:proposal, /openspec:apply, /openspec:archive |
| Cursor | /openspec-proposal, /openspec-apply, /openspec-archive |
| Codex | /openspec-proposal, /openspec-apply, /openspec-archive |
| GitHub Copilot | /openspec-proposal, /openspec-apply, /openspec-archive |
| OpenCode | /openspec-proposal, /openspec-apply, /openspec-archive |
| Windsurf | /openspec-proposal, /openspec-apply, /openspec-archive |
| +15 more | See Integrations |
AGENTS.md Compatible
Section titled “AGENTS.md Compatible”These tools read instructions from openspec/AGENTS.md automatically:
- Jules
- Amp
- Any AGENTS.md compatible tool
Non-Interactive Installation
Section titled “Non-Interactive Installation”For CI/CD or scripts:
# Select specific toolsopenspec init --tools claude,cursor
# Select all available toolsopenspec init --tools all
# Skip tool configurationopenspec init --tools noneUpdating OpenSpec
Section titled “Updating OpenSpec”bun install -g @clanker-guru/openspec@latestThen refresh your project’s AI instructions:
openspec updateTroubleshooting
Section titled “Troubleshooting”Slash commands not appearing
Section titled “Slash commands not appearing”Restart your AI coding assistant. Slash commands are loaded at startup.
Permission errors
Section titled “Permission errors”Ensure you have write access to the project directory.
Bun not found
Section titled “Bun not found”Install Bun from bun.sh:
curl -fsSL https://bun.sh/install | bash