* test(#2329): fail-first tests for opencode commands/ (plural) command dir Red phase, empirically probed: global/local install lands in command/ (singular) with 71 gsd-*.md files and no commands/; the manifest records 71 keys under command/ and zero under commands/; all four declaring sites report 'command'. Migration coverage is black-box (two sequential install runs against one configDir) so it holds regardless of how the fix implements cleanup. The Kilo guard passes today by design — a forward-looking no-collateral check. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SLufH5sDuqA1AiEGu45cuA * fix(#2329): write opencode commands to commands/ (plural), migrate legacy command/ OpenCode discovers slash commands from commands/ (plural); the installer wrote them to command/ (singular), so none of the ~71 /gsd-* commands appeared in the TUI. Five sites declared the directory and all had to agree: - capabilities/opencode/capability.json: both artifactLayout destSubpath entries (global + local) and hostBehaviors.flatCommandDir - bin/install.js: the manifest prefix was a SEPARATE hardcoded 'command/' literal, so the manifest would have diverged from the descriptor even after a rename. It now derives from _hostBehaviors(runtime).flatCommandDir. - src/install-engine.cts installOpencodeFamilyArtifacts: the actual write target, which bypasses resolveRuntimeArtifactLayout via combinedFamilyInstall. This was a fifth site the issue did not list — without it the descriptor change alone would not have moved a single file. Migration: an upgrade over a pre-fix install removes only manifest-proven GSD-managed files from the legacy command/ dir and rmdirs it once empty. Unmanifested user files are preserved, never deleted. Kilo shares the opencode family install path and is explicitly unaffected — pinned by a no-collateral test. Note on the tests: the migration cases originally built their legacy fixture by running the installer and relying on it to produce command/ — i.e. they depended on the bug to set up the fixture, and became unsatisfiable the moment it was fixed (block 1 requires command/ to be absent after a fresh install). They now fabricate the legacy layout explicitly, including rewriting the manifest keys to the command/ prefix — which is load-bearing, since the migration only removes manifest-proven files and an unrewritten fixture would silently no-op and pass even against a broken migration. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SLufH5sDuqA1AiEGu45cuA * test(#2329): regenerate opencode install golden after rebase onto next The golden conflicted on rebase because #2322 also regenerated it. Resolved by regenerating from the merged source rather than hand-merging a generated file; the only delta is the 71 command/gsd-*.md -> commands/gsd-*.md key renames. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SLufH5sDuqA1AiEGu45cuA * test(#2329): update stale tests that pinned opencode's singular command/ dir Seven tests encoded the old contract (opencode: command/gsd-help.md exists, the descriptor's flatCommandDir, the install-integration contract, and the resolveRuntimeArtifactLayout golden). They passed in the red phase precisely because they pinned the buggy singular dir; the fix intentionally changes that contract, so these are stale-test corrections, not regressions. Kilo shares the opencode family install path and is deliberately NOT changing — it stays on command/ (singular). The shared opencode/kilo test is now split via an explicit per-runtime dir map so the two cannot be conflated, and Kilo's own layout test is untouched. tests/opencode-command-dir-plural.test.cjs independently pins Kilo unchanged end-to-end. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SLufH5sDuqA1AiEGu45cuA * docs(#2329): changeset for opencode commands/ dir fix Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SLufH5sDuqA1AiEGu45cuA * docs(#2329): backfill PR number 2354 into changeset Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SLufH5sDuqA1AiEGu45cuA * docs(#2329): correct the changeset — do not assert opencode ignores command/ The changeset repeated the issue's stated mechanism ("OpenCode discovers them from commands/ ... a clean install produced no usable commands in the TUI at all"). OpenCode's source contradicts that: packages/core/src/v1/config/command.ts globs {command,commands}/**/*.md, so BOTH names resolve, and its own skill doc still calls .opencode/command/ typical. Shipping that claim as a release note would document a mechanism that does not exist. The change is still right, for the stronger reason: OpenCode's config docs list plural as the convention and singular as backwards compatibility, so GSD was shipping on the alias the vendor may withdraw. Reworded to describe it as the alignment it is, decided on OpenCode's source and docs rather than on bug reports in either repo. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SLufH5sDuqA1AiEGu45cuA * fix(#2329): baseline opencode's commands/ surface — closes a data-loss path this PR opened Not a bookkeeping gap. Moving opencode's command dir to commands/ moved the install destination to a surface the first-time baseline scan does not cover: 000-first-time-baseline's RUNTIME_SURFACES.opencode lists ['gsd-core','command', 'skills','agents'] — no 'commands'. installOpencodeFamilyCommands unconditionally unlinks every gsd-*.md under its destination before writing the fresh set (install-engine.cts:870-873), with zero manifest or migration involvement. The only thing that protects a pre-existing file is assertInstallerMigrationsUnblocked, which runs before materialization and halts when the baseline scan flags an unknown file at a KNOWN surface. Probed: a pre-existing commands/gsd-plan.md is silently destroyed (install exits 0). The identical file under the legacy, already-baselined command/ surface correctly halts the install with "installer migration blocked pending user choice". So this PR would have traded a protected surface for an unprotected one. Fixed with a NEW fix-forward migration rather than editing 000, per docs/installer-migrations.md:131-134 — an applied migration never re-runs, so editing 000 would only protect fresh installs and leave every existing machine exposed. A new id runs for both populations and drifts no shipped checksum; adding its entry to EXPECTED_CHECKSUMS is the case that test explicitly sanctions. All five pre-existing shipped checksums verified byte-identical. Kilo is excluded by the migration's runtimes filter and keeps command/. This was previously deferred as a PR-body note claiming "low impact — nothing else acts on baseline-scan misses". That claim was never probed and was wrong. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SLufH5sDuqA1AiEGu45cuA * docs(#2329): drop the parenthetical product description from the changeset The product-name purity guard (#1777) rejects "Kilo (which still uses command/)" — fragment prose renders verbatim into CHANGELOG.md, so a product name must not carry a parenthetical. Reworded to a plain sentence; the meaning is unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SLufH5sDuqA1AiEGu45cuA --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
518 lines
29 KiB
Markdown
518 lines
29 KiB
Markdown
# Installer Migration Architecture
|
|
|
|
This document defines the migration layer for GSD installs and upgrades.
|
|
It is for contributors who need to retire files, move install surfaces,
|
|
rewrite runtime config, or preserve user data while changing how GSD is
|
|
installed.
|
|
|
|
After reading this document, a contributor should be able to add a new
|
|
installer migration without guessing which files are safe to remove or how
|
|
to protect local user changes.
|
|
|
|
## Problem
|
|
|
|
The installer already handles several upgrade behaviors:
|
|
|
|
- replacing GSD-managed command, skill, agent, hook, and engine files
|
|
- backing up locally modified managed files before replacement
|
|
- preserving known user-owned artifacts
|
|
- cleaning old hook files and hook registrations
|
|
- rewriting runtime-specific configuration formats
|
|
- rolling back some failed Codex installs
|
|
|
|
Those behaviors are currently distributed across install branches. That
|
|
works for isolated fixes, but it makes feature retirement risky. A future
|
|
change can remove a file from the package while leaving stale installed
|
|
copies behind, or delete a user-created file because it happens to live
|
|
inside a GSD-managed directory.
|
|
|
|
The migration layer exists to make upgrade behavior explicit, reviewed, and
|
|
repeatable.
|
|
|
|
## Design Goals
|
|
|
|
1. Protect user data by default.
|
|
2. Remove stale GSD-managed files when a feature is retired.
|
|
3. Make destructive actions visible before they run.
|
|
4. Record what happened so future installs do not re-run the same migration.
|
|
5. Give each runtime the same safety model, even when the concrete files differ.
|
|
6. Keep migration authoring small enough that contributors use it instead of
|
|
adding another one-off cleanup block.
|
|
|
|
## Non-Goals
|
|
|
|
- This is not a general package manager.
|
|
- This is not a database migration system.
|
|
- This does not automatically infer every historical install layout.
|
|
- This does not remove arbitrary user files.
|
|
- This does not replace the existing install transforms in one step.
|
|
|
|
## Terms
|
|
|
|
**Managed file**
|
|
|
|
A file that GSD installed and recorded in the install manifest. Managed files
|
|
can be replaced automatically when unchanged. If changed locally, they must be
|
|
backed up or merged.
|
|
|
|
**User-owned file**
|
|
|
|
A file created or maintained by a user workflow or by the user directly. These
|
|
files must never be removed just because they sit under a GSD directory.
|
|
|
|
**Unknown file**
|
|
|
|
A file found under an install root that is not in the manifest and is not
|
|
classified as user-owned. Unknown files are preserved unless a migration
|
|
explicitly classifies them with evidence.
|
|
|
|
**Migration**
|
|
|
|
A versioned change set that can inspect the current install, produce a plan,
|
|
and apply that plan after safety checks pass.
|
|
|
|
**Plan**
|
|
|
|
A list of proposed filesystem and config actions. A plan is safe to show to a
|
|
user. It describes what will happen and why, without mutating disk.
|
|
|
|
**Journal**
|
|
|
|
A per-run record of applied actions and rollback data. It exists so failed
|
|
installs can restore the pre-run state where possible.
|
|
|
|
## State Files
|
|
|
|
The migration layer uses the existing file manifest and adds one install-state
|
|
record.
|
|
|
|
### File Manifest
|
|
|
|
The existing manifest remains the ownership baseline. It records the installed
|
|
GSD version, install mode, and hashes for distribution-owned files.
|
|
|
|
The invariant is strict:
|
|
|
|
- distribution-owned files are manifest-tracked
|
|
- user-owned files are preserved and omitted from manifest hashes
|
|
- a path cannot be both
|
|
|
|
### Install State
|
|
|
|
The installer writes an install-state file next to the manifest.
|
|
|
|
Required fields:
|
|
|
|
```json
|
|
{
|
|
"schema": 1,
|
|
"runtime": "codex",
|
|
"scope": "global",
|
|
"installed_version": "1.50.0",
|
|
"install_mode": "full",
|
|
"applied_migrations": [
|
|
{
|
|
"id": "2026-05-11-codex-hooks-layout",
|
|
"package_version": "1.50.0",
|
|
"checksum": "sha256:...",
|
|
"applied_at": "2026-05-11T00:00:00.000Z"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
The checksum is calculated from the migration definition.
|
|
|
|
An already-applied migration is never re-run, so a drifted checksum is
|
|
tolerated at runtime: it is collected in `plan.checksumDrift` and reconciled
|
|
into install state on the next write, rather than aborting the user's upgrade
|
|
(this unblocks upgrades — see issue #670).
|
|
|
|
The "shipped migration bodies are immutable" rule is enforced in CI by a
|
|
committed checksum-baseline test in `tests/installer-migrations.test.cjs`.
|
|
If you need to change the behaviour of a released migration, add a NEW
|
|
fix-forward migration id instead of editing the shipped body.
|
|
|
|
## Migration Record
|
|
|
|
Each migration exports a plain record plus pure planning logic.
|
|
|
|
Required fields:
|
|
|
|
```js
|
|
module.exports = {
|
|
id: '2026-05-11-runtime-layout-example',
|
|
title: 'Move legacy commands into runtime skills',
|
|
description: 'Move legacy runtime command files into the generated skill layout.',
|
|
introducedIn: '1.50.0',
|
|
runtimes: ['claude', 'codex', 'antigravity'],
|
|
scopes: ['global', 'local'],
|
|
destructive: true,
|
|
plan(ctx) {
|
|
return [];
|
|
}
|
|
};
|
|
```
|
|
|
|
The Installer Migration Authoring Guard Module rejects records that omit `id`,
|
|
`title`, `description`, `introducedIn`, `scopes`, `destructive`, or `plan`.
|
|
`runtimes` remains optional only for migrations intentionally shared by every
|
|
runtime, but scope must always be explicit so an author cannot accidentally
|
|
broaden local/global behavior.
|
|
|
|
The `plan(ctx)` function receives an install context with runtime, scope,
|
|
target directory, previous manifest, install state, package manifest, and
|
|
filesystem helpers. It returns actions. It must not mutate disk.
|
|
|
|
Migrations may use helper predicates such as:
|
|
|
|
- `isManaged(relPath)`
|
|
- `isUserOwned(relPath)`
|
|
- `hashMatchesManifest(relPath)`
|
|
- `exists(relPath)`
|
|
- `readJson(relPath)`
|
|
- `readToml(relPath)`
|
|
|
|
## Action Types
|
|
|
|
Migrations produce a small set of action types. The executor owns mutation,
|
|
backup, rollback, and reporting.
|
|
|
|
### remove-managed
|
|
|
|
Remove a path only when it is known to be GSD-managed and unchanged from the
|
|
previous manifest, or when the migration provides a purpose-built detector for
|
|
an old GSD-owned shape.
|
|
|
|
Authoring guardrail: every `remove-managed` action must include
|
|
`ownershipEvidence` explaining the manifest entry, generated marker, or
|
|
purpose-built detector that proves GSD ownership.
|
|
|
|
Use for retired hooks, old generated agents, deprecated command files, and
|
|
stale runtime-specific generated artifacts.
|
|
|
|
### backup-and-remove
|
|
|
|
Back up a managed path before removal because the file differs from the
|
|
previous manifest. The user gets a clear report and can inspect the backup.
|
|
|
|
Use when a feature retires a managed file that users may have patched.
|
|
|
|
### move-managed
|
|
|
|
Move a managed path to a new managed path. If the source was locally modified,
|
|
the action becomes `backup-and-move` or a conflict.
|
|
|
|
Use for layout migrations such as command directories moving into skills.
|
|
|
|
### rewrite-config
|
|
|
|
Rewrite a structured config file through a parser or existing structural helper.
|
|
String replacement is only acceptable for narrowly-scoped marker blocks with
|
|
tests for line-ending and ordering variations.
|
|
|
|
Use for runtime config, hook registrations, feature flags, and generated
|
|
agent registration blocks.
|
|
|
|
The initial executor support is `rewrite-json`: a migration reads JSON through
|
|
`readJson(relPath)`, returns the next parsed value in the action, and may set
|
|
`deleteIfEmpty: true` when the remaining structure is empty. The executor owns
|
|
the disk write, journal entry, rollback snapshot, and runtime/scope filtering.
|
|
Use this for legacy JSON config cleanup such as Codex `hooks.json`, where GSD
|
|
can prove ownership of individual generated hook commands but not the whole
|
|
file.
|
|
|
|
Authoring guardrail: every `rewrite-json` action must include
|
|
`ownershipEvidence`, and the migration record must include `runtimeContract`
|
|
citing `docs/installer-migrations.md#runtime-configuration-contract-registry`.
|
|
|
|
### preserve-user
|
|
|
|
Declare that a path is user-owned and must survive surrounding directory
|
|
replacement. This action is informational in dry-run output. During apply it
|
|
becomes a copy-through/restore operation when baseline ownership is known; when
|
|
ownership is not yet established, non-interactive apply must block until an
|
|
interactive baseline migration records an explicit user choice.
|
|
|
|
Use for profile, preferences, hand-authored instructions, and future workflow
|
|
outputs.
|
|
|
|
### record-baseline
|
|
|
|
Record a manifest-managed file in the first-time baseline without mutating it.
|
|
The executor writes a journal entry and install-state entry so later upgrades
|
|
know the baseline scan completed.
|
|
|
|
Use only from the first-time baseline scanner.
|
|
|
|
### baseline-preserve-user
|
|
|
|
Record a user-owned or unknown file discovered under a known install surface
|
|
without mutating it. Unknown files default to this action unless they look like
|
|
retired GSD-generated artifacts that need an explicit user choice.
|
|
|
|
Use only from the first-time baseline scanner.
|
|
|
|
### prompt-user
|
|
|
|
Stop non-interactive destructive migration and ask in interactive mode. The
|
|
prompt must present concrete choices such as preserve, back up, remove, or
|
|
move. The default is preserve.
|
|
|
|
Use when classification is ambiguous and guessing could lose data.
|
|
|
|
## Execution Flow
|
|
|
|
The installer runs migrations before materializing the new package payload.
|
|
|
|
1. Build install context.
|
|
2. Read prior manifest and install state.
|
|
3. Build a pre-run snapshot for paths that may be touched.
|
|
4. Discover pending migrations by runtime, scope, and applied state.
|
|
5. Ask each pending migration for a plan.
|
|
6. Merge plans and validate them.
|
|
7. Print the plan in dry-run form.
|
|
8. Apply safe non-interactive actions.
|
|
9. Prompt or stop for ambiguous actions.
|
|
10. Write the new package payload.
|
|
11. Write the new manifest and install state.
|
|
12. Report backups, preserved files, removed stale files, and skipped actions.
|
|
|
|
The Phase 4 install integration wires this flow into the normal install/update
|
|
entry point for every supported runtime: Claude Code, Antigravity, Augment,
|
|
Cline, CodeBuddy, Codex, Copilot, Cursor, Hermes Agent, Kilo, OpenCode,
|
|
Qwen Code, Trae, and Windsurf. The installer invokes the same migration runner
|
|
with `baselineScan: true`, reports the projected action rows, applies safe
|
|
non-interactive actions before materialization, persists install state only after
|
|
package materialization and finalization succeed, and fails before writing new package files when the runner
|
|
returns blocked user-choice actions.
|
|
|
|
Phase 1-3 built the planning, apply, rollback, install-state, baseline, and
|
|
migration-record mechanics. Those phases did not prove the normal install entry
|
|
point across every runtime. Phase 4 owns that guardrail with an all-runtime
|
|
install matrix that exercises safe managed cleanup and blocked user-choice
|
|
artifacts for each runtime above.
|
|
|
|
If any apply step fails, the executor uses the journal to restore modified
|
|
paths where possible. Rollback must never delete files that were not created
|
|
or modified by the current installer run.
|
|
|
|
## Dry Run
|
|
|
|
The migration runner supports a dry-run mode that prints the plan and exits
|
|
without changes.
|
|
|
|
Dry-run output groups actions by risk:
|
|
|
|
- will preserve
|
|
- will replace unchanged managed files
|
|
- will remove stale managed files
|
|
- will back up locally modified files
|
|
- needs user choice
|
|
- blocked
|
|
|
|
The same planner powers dry-run and apply. There must not be a separate
|
|
"preview-only" code path.
|
|
|
|
## Safety Policy
|
|
|
|
### Ownership
|
|
|
|
Never remove an unknown file. Unknown files are preserved unless a migration
|
|
contains a specific detector proving the file is a stale GSD artifact.
|
|
|
|
### Modification Detection
|
|
|
|
When a path is in the previous manifest:
|
|
|
|
- hash match means unchanged managed file
|
|
- hash mismatch means locally modified managed file
|
|
- missing means already removed by the user and should stay removed unless a
|
|
migration explicitly needs to recreate it
|
|
|
|
### User-Owned Artifacts
|
|
|
|
User-owned artifacts are defined once and consumed by both preservation and
|
|
manifest-writing code. Adding a user-owned artifact requires a regression test
|
|
that proves it is preserved across reinstall and omitted from the manifest.
|
|
|
|
### Config Files
|
|
|
|
Runtime config is mixed ownership. GSD may own marker blocks, generated agent
|
|
sections, or hook entries, but it does not own the whole file unless the file
|
|
was created as a GSD-only file. Config migrations should remove or rewrite
|
|
only the owned portion.
|
|
|
|
## Runtime Configuration Contract Registry
|
|
|
|
Last upstream documentation check: 2026-05-11. Kimi CLI was rechecked on
|
|
2026-06-07 against the MoonshotAI docs.
|
|
|
|
This registry is the source of truth for migrations that touch host runtime
|
|
configuration. Each row records:
|
|
|
|
- **What:** the GSD invocation, agent, skill, rule, hook, or config surface
|
|
- **Where:** the global and local roots the installer targets
|
|
- **When:** install, upgrade, uninstall, and migration touch points
|
|
- **Who:** the ownership boundary for surrounding user config
|
|
- **Why:** the upstream loader contract or current GSD compatibility shim
|
|
|
|
Migration authors must read the matching row before producing a
|
|
`rewrite-config`, `move-managed`, or destructive cleanup action. If upstream
|
|
docs change, update this registry, update `docs/ARCHITECTURE.md`, and add tests
|
|
for the new shape before changing migration behavior.
|
|
|
|
| Runtime | What GSD installs | Where GSD installs it | Config ownership boundary | Upstream contract snapshot |
|
|
| --- | --- | --- | --- | --- |
|
|
| Claude Code | Global skills in `skills/gsd-*/SKILL.md`; local slash commands in `commands/gsd/*.md`; agents in `agents/gsd-*.md`; hooks in `hooks/`; `settings.json` registrations | Global `CLAUDE_CONFIG_DIR` or `~/.claude`; local `./.claude` | GSD owns only generated skills, local commands, `gsd-*` agents, hook files, and GSD hook/statusLine entries in `settings.json` | [Slash commands](https://docs.anthropic.com/en/docs/claude-code/slash-commands), [settings](https://docs.anthropic.com/en/docs/claude-code/settings), [hooks](https://docs.anthropic.com/en/docs/claude-code/hooks), [subagents](https://docs.anthropic.com/en/docs/claude-code/sub-agents); docs not versioned, checked 2026-05-11 |
|
|
| OpenCode | Flat markdown commands in `commands/gsd-*.md` (plural — OpenCode discovers slash commands from `commands/`, not the legacy singular `command/`, #2329); agents in `agents/gsd-*.md`; config updates in `opencode.json` or `opencode.jsonc` | Global `OPENCODE_CONFIG_DIR`, `dirname(OPENCODE_CONFIG)`, `XDG_CONFIG_HOME/opencode`, or `~/.config/opencode`; local `./.opencode` | GSD owns generated command/agent files and GSD entries in structured config only | [Config](https://opencode.ai/docs/config/), [Commands](https://opencode.ai/docs/commands/); docs published 2026-05, checked 2026-07-16 |
|
|
| Kilo | OpenCode-style flat markdown commands in `command/gsd-*.md`; agents in `agents/gsd-*.md`; config updates in `kilo.json` or `kilo.jsonc` | Global `KILO_CONFIG_DIR`, `dirname(KILO_CONFIG)`, `XDG_CONFIG_HOME/kilo`, or `~/.config/kilo`; local `./.kilo` | GSD owns generated command/agent files and GSD entries in structured config only | [Custom subagents](https://docs.kilo.ai/docs/customize/custom-subagents); docs not versioned, checked 2026-05-11 |
|
|
| Kimi CLI | Agent Skills in `skills/gsd-*/SKILL.md`; explicit custom agent YAML/prompt artifacts in `agents/gsd.yaml`, `agents/gsd.md`, and `agents/subagents/gsd-*`; `gsd-core/` payload files referenced by generated skills; manifest, pristine, local-patch, and migration journal files from the normal installer safety pipeline | Global `KIMI_CONFIG_DIR`, explicit `--config-dir`, or first-existing generic skills root: `~/.config/agents` when `~/.config/agents/skills` exists or no generic skills root exists yet, otherwise `~/.agents` when `~/.agents/skills` exists and `~/.config/agents/skills` does not; `KIMI_CONFIG_DIR` and `--config-dir` are GSD write-location overrides and arbitrary roots require Kimi-side `--skills-dir` or `extra_skill_dirs` configuration for skill discovery; local `--kimi --local` is guarded and writes no project-level artifacts | GSD owns only generated `skills/gsd-*`, `agents/gsd.*`, `agents/subagents/gsd-*`, installed `gsd-core/` payload files, and manifest/preservation/migration records. GSD does not own Kimi config files, hooks, settings, rules, statusline, update-banner registration, or non-GSD Kimi skills/agents. Reinstall/update must preserve locally modified generated Kimi artifacts through manifest-backed `gsd-local-patches/`; uninstall removes only GSD-owned Kimi artifacts and preserves non-GSD user content. | [Agent Skills](https://moonshotai.github.io/kimi-cli/en/customization/skills.html), [Agents and Subagents](https://moonshotai.github.io/kimi-cli/en/customization/agents.html), [Tools](https://moonshotai.github.io/kimi-code/en/reference/tools.html); docs checked 2026-06-07 |
|
|
| Codex | Skills in `skills/gsd-*/SKILL.md`; agents as source markdown plus per-agent TOML in `agents/`; `[agents.gsd-*]` and hooks in `config.toml` | Global `CODEX_HOME` or `~/.codex`; local `./.codex` | GSD owns generated skills, generated agent TOML, `agents.gsd-*` config sections, `[features].hooks` when added by GSD (canonical; legacy alias `codex_hooks` is recognized and migrated forward, #3566), and GSD hook entries | [Codex config schema](https://developers.openai.com/codex/config-schema.json), [Codex developer docs](https://developers.openai.com/codex/); docs not versioned, checked 2026-05-15; installer compatibility sentinel: Codex 0.130.0 features.hooks key (legacy `codex_hooks` recognized) |
|
|
| GitHub Copilot | Skills in `skills/gsd-*/SKILL.md`; agents as `.agent.md`; repository instructions in `copilot-instructions.md` | Global `COPILOT_CONFIG_DIR`, `COPILOT_HOME`, or `~/.copilot`; local `./.github` | GSD owns generated skill/agent files and GSD-authored instruction files; no hook/statusline ownership | [Repository custom instructions](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions), [Copilot CLI custom instructions](https://docs.github.com/en/copilot/how-tos/copilot-cli/add-custom-instructions); GitHub Docs product docs, checked 2026-05-11 |
|
|
| Antigravity | Skills in `skills/gsd-*/SKILL.md`; agents in `agents/`; Gemini-style `settings.json` hooks when installed by GSD | Global `ANTIGRAVITY_CONFIG_DIR` or `~/.gemini/antigravity`; local `./.agents` (canonical, #791) or `./.agent` (legacy, recognized for backward-compat) | GSD owns generated skills/agents/hooks and GSD settings entries only | Public Antigravity install/config docs for this file layout were not stable or complete as of 2026-05-11; installer compatibility therefore uses GSD's Gemini-compatible settings policy, documented shim baseline. Fresh installs write to `.agents/` (the Google-Codelabs-documented form); existing `.agent/` installs continue to be detected and served. |
|
|
| Cursor | Skills in `skills/gsd-*/SKILL.md`; agents in `agents/`; rule references under `rules/`; lifecycle hooks via `hooks.json` (sessionStart + postToolUse, #777) | Global `CURSOR_CONFIG_DIR` or `~/.cursor`; local `./.cursor` | GSD owns generated skills/agents, GSD rule files or references, and GSD-managed `hooks.json` entries (sentinel `gsd-managed:true`); no statusline ownership | [Cursor rules](https://docs.cursor.com/context/rules); [Cursor hooks](https://docs.cursor.com/context/hooks); docs not versioned, checked 2026-06-07 |
|
|
| Windsurf / Devin Desktop | Local slash-command workflows in `workflows/gsd-*.md`; no custom-agent artifact surface | Local workflow directory `./.windsurf/workflows`; global workflow install is intentionally a no-op | GSD owns generated local workflow files only; no hook/statusline ownership | Windsurf workflows are the documented `/` command surface. Workspace workflows live under `.windsurf/workflows/*.md`; global workflow locations are outside GSD's normal user-owned runtime config directory and are not written by the GSD installer. |
|
|
| Augment Code | Skills in `skills/gsd-*/SKILL.md`; agents in `agents/` | Global `AUGMENT_CONFIG_DIR` or `~/.augment`; local `./.augment` | GSD owns generated skills/agents only; no hook/statusline ownership | [Augment Agent Skills](https://docs.augmentcode.com/cli/skills), [Augment IDE skills](https://docs.augmentcode.com/using-augment/skills); IDE skills public beta in VS Code 0.789.0+, checked 2026-05-11 |
|
|
| Trae | Skills in `skills/gsd-*/SKILL.md`; agents in `agents/`; rule references under `rules/` | Global `TRAE_CONFIG_DIR` or `~/.trae`; local `./.trae` | GSD owns generated skills/agents and GSD rule files or references; no hook/statusline ownership | Public Trae docs expose AI settings and `.rules` announcements, but no stable skills/config API was found as of 2026-05-11; migrations must treat this row as source-limited |
|
|
| Qwen Code | Claude-compatible skills in `skills/gsd-*/SKILL.md`; agents in `agents/`; optional common hook/settings integration through GSD | Global `QWEN_CONFIG_DIR` or `~/.qwen`; local `./.qwen` | GSD owns generated skills/agents/hooks and GSD settings entries only | [Qwen commands and skills](https://qwenlm.github.io/qwen-code-docs/en/users/features/commands/); docs last updated 2026-05-06 |
|
|
| Hermes Agent | Category skills under `skills/gsd/` with `DESCRIPTION.md` plus nested `gsd-*/SKILL.md`; agents in `agents/`; optional common hook/settings integration through GSD | Global `HERMES_HOME` or `~/.hermes`; local `./.hermes` | GSD owns generated `skills/gsd/` category content, generated agents, and GSD settings entries only | [Hermes configuration](https://hermes-agent.nousresearch.com/docs/user-guide/configuration), [Hermes skills](https://hermes-agent.nousresearch.com/docs/zh-Hans/user-guide/features/skills), [working with skills](https://hermes-agent.nousresearch.com/docs/guides/work-with-skills); docs checked 2026-05-11 |
|
|
| CodeBuddy | Skills in `skills/gsd-*/SKILL.md`; agents in `agents/`; optional common hook/settings integration through GSD | Global `CODEBUDDY_CONFIG_DIR` or `~/.codebuddy`; local `./.codebuddy` | GSD owns generated skills/agents/hooks and GSD settings entries only | [CodeBuddy CLI skills](https://www.codebuddy.ai/docs/cli/skills), [CodeBuddy IDE skills](https://www.codebuddy.ai/docs/ide/Features/Skills); docs checked 2026-05-11 |
|
|
| Cline | Rule-based integration via `.clinerules` for current installer output | Global `CLINE_CONFIG_DIR` or `~/.cline`; local project root `.clinerules` | GSD owns the generated `.clinerules` file only when it created or manifest-tracked it; no hooks/statusline ownership | [Cline rules](https://docs.cline.bot/customization/cline-rules); docs prefer `.clinerules/` directory and still detect legacy rule files, checked 2026-05-11 |
|
|
|
|
### Registry Authoring Rules
|
|
|
|
- Use structured parsers for config files whenever the runtime provides JSON,
|
|
JSONC, TOML, or YAML. Marker-block rewrites need line-ending and ordering
|
|
tests.
|
|
- Do not claim ownership of a mixed config file. Own only generated entries,
|
|
generated files, and explicit marker blocks.
|
|
- Preserve unknown user config, even when it sits inside a GSD-managed runtime
|
|
root.
|
|
- Add or update the upstream snapshot date and version note when a runtime's
|
|
docs, CLI schema, or loader behavior changes.
|
|
- Treat source-limited rows as high-risk. A migration that rewrites those
|
|
runtimes needs either a new primary source or an installer-level probe with
|
|
tests.
|
|
|
|
### Rollback
|
|
|
|
Before applying a migration, the executor records enough data to restore:
|
|
|
|
- file bytes before overwrite
|
|
- directory membership before removing generated directories
|
|
- config bytes before structured rewrite
|
|
- paths created by the current run
|
|
- temporary files created by atomic writes
|
|
|
|
Rollback is best-effort but must be loud when incomplete.
|
|
|
|
## First-Time Baseline Migration
|
|
|
|
The first migration should classify an existing install rather than attempt
|
|
to fix every historical layout.
|
|
|
|
It should:
|
|
|
|
1. read the current manifest if present
|
|
2. scan known runtime install surfaces
|
|
3. classify files as managed, user-owned, or unknown
|
|
4. report stale GSD-looking files that are not in the current manifest
|
|
5. offer actions for ambiguous files instead of deleting them
|
|
6. write install state after successful classification
|
|
|
|
The Phase 3 implementation adds a gated baseline migration record,
|
|
`2026-05-11-first-time-baseline-scan`. The runner passes `baselineScan: true`
|
|
when the installer wants this first-time scan. Without that flag, discovery is
|
|
safe for normal migration runs and the baseline record plans no actions.
|
|
|
|
The baseline action contract is:
|
|
|
|
- `record-baseline` for manifest-managed files
|
|
- `baseline-preserve-user` for known user-owned files and unknown files that do
|
|
not look like stale GSD-generated artifacts
|
|
- `prompt-user` for stale GSD-looking artifacts that are not manifest-proven
|
|
|
|
This baseline is the escape hatch for old installs that predate full migration
|
|
tracking. It gives the user a reviewable redistribution/removal plan without
|
|
requiring the installer to infer every past release transition perfectly.
|
|
|
|
## Authoring Workflow
|
|
|
|
When a feature removes or moves install artifacts, the PR must include:
|
|
|
|
1. a migration record
|
|
2. tests for dry-run plan output
|
|
3. tests for apply behavior
|
|
4. tests for locally modified managed files
|
|
5. tests for user-owned files near the changed path
|
|
6. an update to release notes if the migration affects user-visible install
|
|
behavior
|
|
|
|
The author must answer these questions in the migration file:
|
|
|
|
- What old artifact or config shape is being retired?
|
|
- How do we prove it is GSD-owned?
|
|
- What happens if the user modified it?
|
|
- What happens if it is missing?
|
|
- What runtime and scope does it affect?
|
|
- Is the action safe in non-interactive install?
|
|
|
|
## Test Matrix
|
|
|
|
Every migration runner change should cover:
|
|
|
|
- fresh install with no prior state
|
|
- reinstall with matching manifest
|
|
- upgrade with pending migration
|
|
- locally modified managed file
|
|
- unknown file under a GSD directory
|
|
- user-owned file under a wiped directory
|
|
- failed apply with rollback
|
|
- global and local install scopes when applicable
|
|
- Windows path separators when paths are serialized
|
|
- CRLF input when config files are rewritten
|
|
|
|
## Implementation Sequence
|
|
|
|
1. Extract install ownership helpers around the manifest and user-owned artifact list.
|
|
2. Add install-state read/write helpers.
|
|
3. Add migration record discovery and checksum calculation.
|
|
4. Add planner-only dry-run support.
|
|
5. Add executor with journaled file actions.
|
|
6. Port orphaned hook/file cleanup into the first explicit migration.
|
|
7. Port one structured config rewrite into the migration runner.
|
|
8. Add the baseline classifier for existing installs.
|
|
9. Make new install-affecting PRs require migrations when artifacts are moved,
|
|
renamed, or retired.
|
|
|
|
This sequence keeps the first implementation small: the existing installer
|
|
continues to materialize files, while the migration runner takes ownership of
|
|
cleanup, classification, and reviewable destructive changes.
|
|
|
|
## Shipped Migrations
|
|
|
|
Each row corresponds to one migration record in `src/installer-migrations/`.
|
|
|
|
| ID | File | Introduced In | Scopes | Destructive | Summary |
|
|
|----|------|---------------|--------|-------------|---------|
|
|
| `2026-05-11-first-time-baseline-scan` | `000-first-time-baseline.cts` | 1.50.0 | global, local | No | Records classification baseline for existing installs before destructive migrations run. |
|
|
| `2026-05-11-legacy-orphan-files` | `001-legacy-orphan-files.cts` | 1.50.0 | global, local | Yes | Removes manifest-managed legacy orphan hook files (`hooks/gsd-notify.sh`, `hooks/statusline.js`) retired by the installer. |
|
|
| `2026-05-11-codex-legacy-hooks-json` | `002-codex-legacy-hooks-json.cts` | 1.50.0 | global, local | Yes | Removes legacy GSD hook registrations from Codex `hooks.json` after the `config.toml` migration. |
|
|
| `2026-06-02-rename-get-shit-done-to-gsd-core` | `003-rename-get-shit-done-to-gsd-core.cts` | 1.2.0 | global, local | Yes | Removes managed files from the stale `get-shit-done/` runtime directory after the rename to `gsd-core/` (#604). User-added files are preserved; emptied directories may remain (framework limitation). <!-- gsd-allow-legacy-name --> |
|
|
| `2026-06-09-prune-stale-pristine-get-shit-done` | `004-prune-stale-pristine-snapshots.cts` | 1.4.3 | global, local | Yes | Removes stale `gsd-pristine/get-shit-done/` snapshot files left behind by migration 003, which caused false `verify-reapply-patches` failures (#934). <!-- gsd-allow-legacy-name -->
|
|
| `2026-07-17-opencode-baseline-commands-dir` | `005-opencode-baseline-commands-dir.cts` | 1.7.0 | global, local | No | Baselines pre-existing files under OpenCode's `commands/` (plural) directory during the first-time scan. #2329 moved OpenCode command materialization to `commands/`, but 000's `RUNTIME_SURFACES.opencode` is a shipped, immutable body that still only names the legacy `command/` alias, so this fix-forward migration widens the scanned surface. OpenCode only; Kilo is unaffected. |
|
|
|
|
## Prior Art
|
|
|
|
The design borrows from established upgrade systems:
|
|
|
|
- Flyway versioned migrations: ordered, once-only changes tracked by checksum.
|
|
- Flyway dry runs: preview planned mutations before applying them.
|
|
- Liquibase changesets and preconditions: declarative changes gated by current
|
|
system state.
|
|
- Debian conffile policy: preserve local configuration and distinguish package
|
|
ownership from user ownership.
|
|
- npm lifecycle scripts: useful as packaging context, but not sufficient as the
|
|
migration mechanism because uninstall and upgrade context are limited.
|