diff options
| author | Jesse Vincent <jesse@fsck.com> | 2026-01-22 14:07:04 -0800 |
|---|---|---|
| committer | Jesse Vincent <jesse@fsck.com> | 2026-01-22 14:07:04 -0800 |
| commit | c3d478dc47c1f5bcc4c8eb85ead8e5a537a9b68f (patch) | |
| tree | e1137706cc1cea5586e58b41f6c5c35a97354dc9 /docs/README.codex.md | |
| parent | e147c303c00a5ca36f61cb8826b5cb72e0884aff (diff) | |
fix: add Windows launcher for Codex CLI (#243, #285)fix/windows-codex-launcher
Windows cannot execute extensionless scripts with shebangs. Added
.cmd wrapper that invokes Node.js directly.
Changes:
- Add .codex/superpowers-codex.cmd (Windows shim)
- Update docs/README.codex.md with Windows installation instructions
- Add Windows troubleshooting section
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Diffstat (limited to 'docs/README.codex.md')
| -rw-r--r-- | docs/README.codex.md | 42 |
1 files changed, 39 insertions, 3 deletions
diff --git a/docs/README.codex.md b/docs/README.codex.md index e43004f..dbf3de4 100644 --- a/docs/README.codex.md +++ b/docs/README.codex.md @@ -19,13 +19,27 @@ Fetch and follow instructions from https://raw.githubusercontent.com/obra/superp ### Installation Steps -#### 1. Clone Superpowers +#### macOS / Linux ```bash mkdir -p ~/.codex/superpowers git clone https://github.com/obra/superpowers.git ~/.codex/superpowers ``` +#### Windows + +**Command Prompt:** +```cmd +mkdir "%USERPROFILE%\.codex\superpowers" +git clone https://github.com/obra/superpowers.git "%USERPROFILE%\.codex\superpowers" +``` + +**PowerShell:** +```powershell +New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.codex\superpowers" +git clone https://github.com/obra/superpowers.git "$env:USERPROFILE\.codex\superpowers" +``` + #### 2. Install Bootstrap The bootstrap file is included in the repository at `.codex/superpowers-bootstrap.md`. Codex will automatically use it from the cloned location. @@ -34,12 +48,20 @@ The bootstrap file is included in the repository at `.codex/superpowers-bootstra Tell Codex: +**macOS / Linux:** ``` Run ~/.codex/superpowers/.codex/superpowers-codex find-skills to show available skills ``` +**Windows:** +``` +Run ~/.codex/superpowers/.codex/superpowers-codex.cmd find-skills to show available skills +``` + You should see a list of available skills with descriptions. +> **Note:** On Windows, always use the `.cmd` extension when running superpowers-codex commands. + ## Usage ### Finding Skills @@ -126,12 +148,26 @@ git pull 2. Check CLI works: `~/.codex/superpowers/.codex/superpowers-codex find-skills` 3. Verify skills have SKILL.md files -### CLI script not executable +### CLI script not executable (macOS/Linux) ```bash chmod +x ~/.codex/superpowers/.codex/superpowers-codex ``` +### Windows: "Open with" dialog or no output + +On Windows, you must use the `.cmd` wrapper: + +```cmd +~/.codex/superpowers/.codex/superpowers-codex.cmd find-skills +``` + +Or invoke with Node directly: + +```cmd +node "%USERPROFILE%\.codex\superpowers\.codex\superpowers-codex" find-skills +``` + ### Node.js errors The CLI script requires Node.js. Verify: @@ -140,7 +176,7 @@ The CLI script requires Node.js. Verify: node --version ``` -Should show v14 or higher (v18+ recommended for ES module support). +Should show v14 or higher (v18+ recommended). ## Getting Help |
