diff --git a/.changeset/swift-coyotes-document.md b/.changeset/swift-coyotes-document.md new file mode 100644 index 000000000..2d0c2f163 --- /dev/null +++ b/.changeset/swift-coyotes-document.md @@ -0,0 +1,5 @@ +--- +type: Changed +pr: 3173 +--- +**USER-GUIDE now documents installing for prerelease runtime editions** — adds a "Installing for Prerelease Editions (Next / Nightly / Insiders / Preview)" section with the `_CONFIG_DIR` env-var reference for every supported runtime. Resolves the discoverability gap behind requests like #3161 (Windsurf Next) without enumerating each prerelease channel as a separately tested runtime. Closes #3172. diff --git a/docs/USER-GUIDE.md b/docs/USER-GUIDE.md index 05516788a..0bd0f58fb 100644 --- a/docs/USER-GUIDE.md +++ b/docs/USER-GUIDE.md @@ -1200,6 +1200,41 @@ npx get-shit-done-cc --qwen --global Skills are installed to `~/.qwen/skills/gsd-*/SKILL.md`. Use the `QWEN_CONFIG_DIR` environment variable to override the default install path. +### Installing for Prerelease Editions (Next / Nightly / Insiders / Preview) + +Many supported runtimes ship a prerelease edition alongside their stable release — Windsurf Next, Cursor Nightly, VS Code Insiders, Codex preview channels, JetBrains EAP, and so on. Prerelease editions read from a sibling configuration directory, so the default install path won't reach them. + +GSD does not enumerate prerelease editions as separate named runtimes. They are accommodated through the existing `_CONFIG_DIR` environment variables and the free-string runtime policy (see [#2517](https://github.com/gsd-build/get-shit-done/issues/2517)) — installs work, paths resolve, GSD operates. Prerelease editions are **best-effort and not separately tested** as part of release CI. + +**Pattern.** Set the runtime's `*_CONFIG_DIR` env var to the prerelease directory before running the installer: + +```bash +WINDSURF_CONFIG_DIR=~/.codeium/windsurf-next npx get-shit-done-cc@latest --windsurf --global +``` + +Select the corresponding stable runtime in the installer prompt. Skills land in the prerelease directory; commands appear in the prerelease editor. + +**Env-var reference for supported runtimes:** + +| Runtime | Stable default | Override env var | +|---|---|---| +| Claude Code | `~/.claude` | `CLAUDE_CONFIG_DIR` | +| Gemini CLI | `~/.gemini` | `GEMINI_CONFIG_DIR` | +| OpenCode | `XDG_CONFIG_HOME/opencode` | `OPENCODE_CONFIG_DIR` | +| Codex | (per Codex CLI) | `--config-dir` flag | +| Copilot | `~/.copilot` | `COPILOT_CONFIG_DIR` | +| Cursor | `~/.cursor` | `CURSOR_CONFIG_DIR` | +| Windsurf | `~/.codeium/windsurf` | `WINDSURF_CONFIG_DIR` | +| Antigravity | `~/.gemini/antigravity` | `ANTIGRAVITY_CONFIG_DIR` | +| Augment | `~/.augment` | `AUGMENT_CONFIG_DIR` | +| Trae | `~/.trae` | `TRAE_CONFIG_DIR` | +| Qwen Code | `~/.qwen` | `QWEN_CONFIG_DIR` | +| Kilo | `~/.config/kilo` | `KILO_CONFIG_DIR` | +| CodeBuddy | `~/.codebuddy` | `CODEBUDDY_CONFIG_DIR` | +| Cline | `~/.cline` | `CLINE_CONFIG_DIR` | + +If your runtime's prerelease channel is not listed, point the matching env var at its config directory and file an issue if the install fails for any reason other than the path mapping. + ### Using Claude Code with Non-Anthropic Providers (OpenRouter, Local) If GSD subagents call Anthropic models and you're paying through OpenRouter or a local provider, switch to the `inherit` profile: `/gsd-config --profile inherit`. This makes all agents use your current session model instead of specific Anthropic models. See also `/gsd-settings` → Model Profile → Inherit.