Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions core/installation.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Install GSD Core into Any AI Coding Runtime in Minutes"
sidebarTitle: "Installation"
description: "Install GSD Core with a single npx command. The interactive installer configures your chosen runtime, scope, and hooks in under two minutes."

Check warning on line 4 in core/installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (opengsd) - vale-spellcheck

core/installation.mdx#L4

Did you really mean 'npx'?
---

GSD Core installs as a set of commands, agents, workflows, and hooks into the configuration directory of your AI coding runtime. The installer handles all runtime-specific adaptation automatically — you answer a few questions, and it writes the correct files to the correct paths.
Expand Down Expand Up @@ -34,7 +34,7 @@

The installer is interactive and will guide you through the setup. Do not copy files from `agents/` or `commands/` directly — the installer applies runtime-specific transformations that are required for each target environment.

## Interactive installer walkthrough

Check warning on line 37 in core/installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (opengsd) - vale-spellcheck

core/installation.mdx#L37

Did you really mean 'walkthrough'?

<Steps>
<Step title="Select your runtime">
Expand All @@ -55,7 +55,7 @@
</Step>

<Step title="Hooks and permissions registered">
For most runtimes, the installer registers GSD's runtime hooks automatically:

Check warning on line 58 in core/installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (opengsd) - vale-spellcheck

core/installation.mdx#L58

Did you really mean 'runtimes'?

Check warning on line 58 in core/installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (opengsd) - vale-spellcheck

core/installation.mdx#L58

Did you really mean 'GSD's'?

- **Status line hook** — displays model, task, directory, and context usage bar
- **Context monitor hook** — injects agent-facing warnings when context runs low
Expand Down Expand Up @@ -87,7 +87,7 @@
</Tab>

<Tab title="Gemini CLI">
Commands use the **colon form** — Gemini namespaces all plugin commands under the plugin ID:

Check warning on line 90 in core/installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (opengsd) - vale-spellcheck

core/installation.mdx#L90

Did you really mean 'namespaces'?

```text
/gsd:command-name
Expand Down Expand Up @@ -142,13 +142,46 @@
# Cursor, global
npx @opengsd/gsd-core@latest --cursor --global

# Windsurf / Devin Desktop, global (--windsurf and --devin-desktop are equivalent)
npx @opengsd/gsd-core@latest --windsurf --global
npx @opengsd/gsd-core@latest --devin-desktop --global

# Antigravity, global
npx @opengsd/gsd-core@latest --antigravity --global

# Cline, global
npx @opengsd/gsd-core@latest --cline --global

# All supported runtimes, global
npx @opengsd/gsd-core@latest --all --global
```

<Note>
Windsurf rebranded to **Devin Desktop**. Both `--windsurf` and `--devin-desktop` select the same runtime — use whichever name matches the product you have installed. Global skills always land in `~/.codeium/windsurf/`.

Check warning on line 160 in core/installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (opengsd) - vale-spellcheck

core/installation.mdx#L160

Did you really mean 'rebranded'?
</Note>

## Workspace directory migrations

Two runtimes have moved their **local** (workspace) install directories to new canonical paths. Fresh `--local` installs write to the new path; the legacy path is still recognized for backward compatibility, so existing projects keep working without manual changes. Global install paths (`~/.codeium/windsurf/`, `~/.gemini/antigravity/`) are unchanged.

Check warning on line 165 in core/installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (opengsd) - vale-spellcheck

core/installation.mdx#L165

Did you really mean 'runtimes'?

| Runtime | New workspace path | Legacy path (still recognized) |
| --- | --- | --- |
| Windsurf / Devin Desktop | `.devin/skills/` | `.windsurf/skills/` |
| Antigravity | `.agents/` | `.agent/` |

When upgrading an existing project, you have two options:

- **Do nothing.** GSD continues to read from the legacy path. This is the safest option for projects shared across teammates who may not have upgraded yet.
- **Migrate to the new path.** Re-run the installer with `--local` in your project directory. GSD writes new artifacts under the canonical path and the legacy directory can be removed once every collaborator is on a current GSD release.

```bash
# Migrate a project from .windsurf/skills/ → .devin/skills/
npx @opengsd/gsd-core@latest --windsurf --local

# Migrate a project from .agent/ → .agents/
npx @opengsd/gsd-core@latest --antigravity --local
```

## Verify the installation

After the installer completes, open your runtime and run:
Expand All @@ -167,7 +200,7 @@

Once GSD Core is installed, run `/gsd-new-project` to begin. The command walks you through an interactive session to define your project, runs parallel research agents to understand your domain, generates a `REQUIREMENTS.md` and `ROADMAP.md`, and leaves you ready to start the phase loop.

See the [Quickstart](/core/quickstart) guide for a complete walkthrough of your first project from install to shipped phase.

Check warning on line 203 in core/installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (opengsd) - vale-spellcheck

core/installation.mdx#L203

Did you really mean 'walkthrough'?

## Updating GSD Core

Expand Down