chore(#604): rename get-shit-done/ runtime directory to gsd-core/ (#615)

* chore(#604): rename get-shit-done/ runtime directory to gsd-core/ Renames the installed runtime directory `get-shit-done/` to `gsd-core/` so the on-disk name matches the package (`@opengsd/gsd-core`), repo, and binary (`gsd-tools`). The npm package name and binary are unchanged; npx/npm consumers are unaffected. Mechanical (bulk, ~90% of the diff): - `git mv get-shit-done gsd-core` - Swept path/identifier references across the repo via `perl -pe 's/get-shit-done(?!-\w)/gsd-core/g'`. The negative lookahead preserves the five legitimate slug variants that are NOT the directory: get-shit-done-{OLD,cc,classic,cli,redux} (old package/repo names). - Build/manifest wiring: package.json (bin, files, coverage globs), tsconfig.build.json (outDir), ~86 .gitignore build-output entries, stryker.config.mjs, scan-ignore files, install.js path strings. - Frozen (not rewritten): CHANGELOG.md history; translated docs (README.<locale>.md and docs/{ja-JP,ko-KR,pt-BR,zh-CN}/). New logic (review here): - src/installer-migrations/003-rename-get-shit-done-to-gsd-core.cts: a proper ADR-0008 installer migration. On upgrade it walks the legacy `~/.claude/get-shit-done/` tree, classifies each file via the prior install manifest, and emits remove-managed / backup-and-remove for managed files while PRESERVING unknown user-added files. Symlink-safe (skips a symlinked root and symlinked entries; bounds-checks every path under configDir). The framework rolls back on install failure. Emptied dirs may remain (framework has no recursive dir-removal primitive) — documented. - scripts/lint-legacy-dir-name.cjs: CI regression guard forbidding the bare `get-shit-done` directory token (split token to avoid self-match; case- insensitive; `(?!-\w)` lookahead allows the slug variants; allowlists CHANGELOG, translated docs, and `gsd-allow-legacy-name` marker lines). Wired into the lint-tests CI job. - Restored scripts/lint-package-identity-drift.cjs detection regexes (the mechanical sweep had wrongly rewritten the old-name patterns it exists to detect) and marked them as intentional legacy references. - TDD tests for the migration and the guard; do.md slash-command guard regex tightened so a `/gsd-core/bin` path segment is not mistaken for a command; changeset + docs/installer-migrations.md row added. Breaking: the installed runtime path moves `~/.claude/get-shit-done/` -> `~/.claude/gsd-core/`. Migration 003 removes the stale legacy dir's managed files (preserving user files) on upgrade. Users with custom hooks/configs hardcoding the old path must update them. Closes #604 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): unsweep pending changesets + allowlist injection-example docs CI fixes for the rename PR: - Do not sweep pending .changeset/*.md (ephemeral release-note fragments, like CHANGELOG); reverted those body edits so 5 pre-existing malformed fragments (missing type/pr) no longer enter the PR diff and trip docs-lint. Allowlisted .changeset/ in the legacy-name guard accordingly. - Allowlisted TEST-EXAMPLES.md and docs/explanation/security-model.md in prompt-injection-scan.sh: they contain intentional injection examples / security-model prose; the path-reference rewrites are kept. CodeQL alerts on this PR are pre-existing (alert lines unchanged by this PR; none in the new migration/guard) and are out of scope for the rename. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): resolve CodeQL alerts surfaced on this PR The rename diff touched files carrying pre-existing CodeQL findings; per the no-pre-existing-dismissal rule, fixing every surfaced alert rather than waving them off. All behavior-preserving: - scripts/ci-test-scope.cjs: build the config-path match from string .includes() instead of a RegExp over an arg-derived value (js/regex-injection). - src/profile-output.cts: escape backslashes before pipe-escaping desc/safeName so the table-cell escape is complete (js/incomplete-sanitization). - tests/{bug-2643,bug-2808,docs-parity-live-registry}: two-pass HTML-comment strip so a bare/unclosed `/g,'')` can let ` replace), so loop fixes do not satisfy it. Made these paths regex-free: - ci-test-scope.cjs splitFiles: char-by-char separator tokenizer (no /[,\\s]+/). - 3 test files: indexOf/slice HTML-comment stripper (no .replace(/<!--/)). Behavior preserved; ci-test-scope + the 3 suites pass; guard clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): unblock security base64 scan on the large rename diff The security job hit its 10m timeout: base64-scan.sh choked on the binary test fixture tests/feat-3594-parser-property-style.test.cjs (embedded NUL/ non-UTF8 bytes -> thousands of bogus blobs + "ignored null byte" warnings), and the ~800-file rename diff is slow to scan regardless. - scripts/base64-scan.sh: skip binary-by-content files (grep -Iq .) — they can't carry base64-obfuscated *text* and feeding NUL bytes through the per-line scanner is pathologically slow. collect_files already filtered binary *extensions*; this catches binary *content* in text extensions. - .github/workflows/security-scan.yml: raise the security job timeout 10m->30m to accommodate very large diffs (the scan itself is unchanged). Verified locally: scan skips the fixture, 0 "ignored null byte" warnings, 0 findings, exit 0. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): sweep get-shit-done refs introduced by merging next The branch was updated with next (#614/#384/#618 etc.), which reference the get-shit-done/ dir (still named that on next). Swept the stale references in the merged files to gsd-core so the rename stays consistent and lint:legacy-name passes: - commands/gsd/discuss-phase.md (runtime-launcher shim paths) - src/core.cts (getAgentsDir layout comments) - tests/bug-384-agents-runtime-aware.test.cjs (require path to runtime lib) Verified: guard 0 violations; build green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): exclude gsd-core/ path segments from bug-3683 command cross-ref invariant The #614 runtime-launcher shim added to discuss-phase.md references `${_GSD_RUNTIME_ROOT}/gsd-core/bin/...`. bug-3683's REF_PATTERN excluded path-y refs only via lookbehind, but `}` precedes `/gsd-core/` in the shim, so it mis-read the directory path as a dangling `/gsd-core` command ref (same class as the #604 bug-2954 fix). Added a trailing `(?![\w-]*\/)` so `/gsd-<x>/...` path segments are not treated as slash-command references. Verified locally on BOTH platforms before pushing: - mac (node 26) full suite: 0 failures - gsd-test-runner (linux, node22 image) full suite: 0 failures - bug-3683 + bug-2954 pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): lazily resolve findProjectRoot in gsd-tools (harden flaky CI) CI intermittently failed state.test's gsd-tools subprocess with "findProjectRoot is not a function" (flip-flopping across legs; not reproducible on mac full suite, gsd-test linux full suite, test:unit, or state.test x8). findProjectRoot is a re-export from core.cjs (sourced from project-root.cjs); binding it via destructure at module-load can be undefined under a load-ordering edge. Resolve it lazily at call time via a small wrapper so the lookup happens after core.cjs is fully initialized. Verified green on BOTH platforms before pushing: - mac (node 26) full suite: 0 failures - gsd-test-runner (linux, node22) full suite: 0 failures - state.test.cjs: 106/106; gsd-tools loads cleanly. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): allowlist verification-patterns.md placeholder examples in secret scan The rename git-mv'd references/verification-patterns.md into gsd-core/, pulling it into the secret-scan diff. It documents stub/placeholder RED-FLAG env-var examples (illustrative Stripe test-key / database-URL / API-key placeholders) — not real credentials. Added it to .secretscanignore with the strict annotation, mirroring the existing gsd-core/workflows/plan-phase.md exception. Verified locally: secret-scan-lint --strict OK; secret-scan --diff origin/next exits 0 with 0 findings. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-02 18:35:29 -04:00
parent b177c1704f
commit 463cffd894
845 changed files with 3316 additions and 2373 deletions
--- a/gsd-core/workflows/settings-integrations.md
+++ b/gsd-core/workflows/settings-integrations.md
@@ -0,0 +1,312 @@
+<purpose>
+Interactive configuration of third-party integrations for GSD — search API keys
+(Brave / Firecrawl / Exa), code-review CLI routing (`review.models.<cli>`), and
+agent-skill injection (`agent_skills.<agent-type>`). Writes to
+`.planning/config.json` via `gsd-tools` so unrelated keys are
+preserved, never clobbered.
+
+This command is deliberately separate from `/gsd:settings` (workflow toggles)
+and any `/gsd-settings-advanced` tuning surface. It exists because API keys and
+cross-tool routing are *connectivity* concerns, not workflow or tuning knobs.
+</purpose>
+
+<security>
+**API keys are secrets.** They are written as plaintext to
+`.planning/config.json` — that is where secrets live on disk, and file
+permissions are the security boundary. The UI must never display, echo, or
+log the plaintext value. The workflow follows these rules:
+
+- **Masking convention: `****<last-4>`** (e.g. `sk-abc123def456` → `****f456`).
+  Strings shorter than 8 characters render as `****` with no tail so a short
+  secret does not leak a meaningful fraction of its bytes. Unset values render
+  as `(unset)`.
+- **Plaintext is never echoed by AskUserQuestion descriptions, confirmation
+  tables, or any log line.** It is not written to any file under `.planning/`
+  other than `config.json` itself.
+- **`config-set` output is masked** for keys in the secret set
+  (`brave_search`, `firecrawl`, `exa_search`) — see
+  `gsd-core/bin/lib/secrets.cjs`.
+- **Agent-type and CLI slug validation.** `agent_skills.<agent-type>` and
+  `review.models.<cli>` keys are matched against `^[a-zA-Z0-9_-]+$`. Inputs
+  containing path separators (`/`, `\`, `..`), whitespace, or shell
+  metacharacters are rejected. This closes off skill-injection attacks.
+</security>
+
+<required_reading>
+Read all files referenced by the invoking prompt's execution_context before starting.
+</required_reading>
+
+<process>
+
+<step name="ensure_and_load_config">
+Ensure config exists and resolve the active config path (flat vs workstream, #2282):
+
+```bash
+_GSD_SHIM_NAME="gsd-tools.cjs"; _GSD_RUNTIME_ROOT="${RUNTIME_DIR:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)}"; GSD_TOOLS="${_GSD_RUNTIME_ROOT}/gsd-core/bin/${_GSD_SHIM_NAME}"; if [ -f "$GSD_TOOLS" ]; then gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${_GSD_RUNTIME_ROOT}/.claude/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${_GSD_RUNTIME_ROOT}/.claude/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif command -v gsd-tools >/dev/null 2>&1; then GSD_TOOLS="$(command -v gsd-tools)"; gsd_run() { "$GSD_TOOLS" "$@"; }; elif [ -f "$HOME/.claude/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="$HOME/.claude/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; else echo "ERROR: gsd-tools.cjs not found at $GSD_TOOLS and gsd-tools is not on PATH. Run: npx -y @opengsd/gsd-core@latest --claude --local" >&2; exit 1; fi
+gsd_run query config-ensure-section
+if [[ -z "${GSD_CONFIG_PATH:-}" ]]; then
+  if [[ -f .planning/active-workstream ]]; then
+    WS=$(tr -d '\n\r' < .planning/active-workstream)
+    GSD_CONFIG_PATH=".planning/workstreams/${WS}/config.json"
+  else
+    GSD_CONFIG_PATH=".planning/config.json"
+  fi
+fi
+```
+
+Store `$GSD_CONFIG_PATH`. Every subsequent read/write uses it.
+</step>
+
+<step name="read_current">
+Read the current config and compute a masked view for display. For each
+integration field, compute one of:
+
+- `(unset)` — field is null / missing
+- `****<last-4>` — secret field that is populated (plaintext never shown)
+- `<value>` — non-secret routing/skill string, shown as-is
+
+```bash
+BRAVE=$(gsd_run query config-get brave_search --default null)
+FIRECRAWL=$(gsd_run query config-get firecrawl --default null)
+EXA=$(gsd_run query config-get exa_search --default null)
+SEARCH_GITIGNORED=$(gsd_run query config-get search_gitignored --default false)
+```
+
+For each secret key (`brave_search`, `firecrawl`, `exa_search`) the displayed
+value is `****<last-4>` when set, never the raw string. Never echo the
+plaintext to stdout, stderr, or any log.
+</step>
+
+<step name="section_1_search_integrations">
+
+**Text mode (`workflow.text_mode: true` or `--text` flag):** Set
+`TEXT_MODE=true` and replace every `AskUserQuestion` call with a plain-text
+numbered list. Required for non-Claude runtimes.
+
+Ask the user what they want to do for each search API key. For keys that are
+already set, show `**** already set` and offer Leave / Replace / Clear. For
+unset keys, offer Skip / Set.
+
+```text
+AskUserQuestion([
+  {
+    question: "Brave Search API key — used for web research during plan/discuss phases",
+    header: "Brave",
+    multiSelect: false,
+    options: [
+      // When already set:
+      { label: "Leave (**** already set)", description: "Keep current value" },
+      { label: "Replace", description: "Enter a new API key" },
+      { label: "Clear", description: "Remove the stored key" }
+      // When unset, use the two-option shape: Skip / Set.
+    ]
+  },
+  {
+    question: "Firecrawl API key — used for deep-crawl scraping",
+    header: "Firecrawl",
+    multiSelect: false,
+    options: [ /* same Leave/Replace/Clear or Skip/Set */ ]
+  },
+  {
+    question: "Exa Search API key — used for semantic search",
+    header: "Exa",
+    multiSelect: false,
+    options: [ /* same Leave/Replace/Clear or Skip/Set */ ]
+  },
+  {
+    question: "Include gitignored files in local code searches?",
+    header: "Gitignored",
+    multiSelect: false,
+    options: [
+      { label: "No (Recommended)", description: "Respect .gitignore. Safer — excludes secrets, node_modules, build artifacts." },
+      { label: "Yes", description: "Include gitignored files. Useful when secrets/artifacts genuinely contain searchable intent." }
+    ]
+  }
+])
+```
+
+For each "Set" or "Replace", follow with a text-input prompt that asks for the
+key value. **The answer must not be echoed back** in subsequent question
+descriptions or confirmation text. Write the value via:
+
+```bash
+gsd_run query config-set brave_search "<value>"     # masked in output
+gsd_run query config-set firecrawl "<value>"        # masked in output
+gsd_run query config-set exa_search "<value>"       # masked in output
+gsd_run query config-set search_gitignored true|false
+```
+
+For "Clear", write `null`:
+
+```bash
+gsd_run query config-set brave_search null
+```
+</step>
+
+<step name="section_2_review_models">
+
+`review.models.<cli>` is a map that tells the code-review workflow which
+shell command to invoke for a given reviewer flavor. Supported flavors:
+`claude`, `codex`, `gemini`, `opencode`.
+
+```text
+AskUserQuestion([
+  {
+    question: "Review model CLI mapping — what next?",
+    header: "Review",
+    multiSelect: false,
+    options: [
+      { label: "Configure CLI", description: "Pick a reviewer flavor and set/clear its command" },
+      { label: "Done", description: "Finish this section" }
+    ]
+  }
+])
+```
+
+If "Configure CLI" is selected, ask:
+
+```text
+AskUserQuestion([
+  {
+    question: "Which reviewer CLI do you want to configure?",
+    header: "CLI",
+    multiSelect: false,
+    options: [
+      { label: "Claude", description: "review.models.claude — defaults to session model when unset" },
+      { label: "Codex", description: "review.models.codex — e.g. 'codex exec --model gpt-5'" },
+      { label: "Gemini", description: "review.models.gemini — e.g. 'gemini -m gemini-2.5-pro'" },
+      { label: "OpenCode", description: "review.models.opencode — e.g. 'opencode run --model claude-sonnet-4'" }
+    ]
+  }
+])
+```
+
+For the selected CLI, show the current value (or `(unset)`) and offer
+Leave / Replace / Clear, followed by a text-input prompt for the new command
+string. Write via:
+
+```bash
+gsd_run query config-set review.models.<cli> "<command string>"
+```
+
+After each update, return to the "Review model CLI mapping — what next?" question.
+Loop until the user selects "Done".
+
+The `review.models.<cli>` key is validated by the dynamic pattern
+`^review\.models\.[a-zA-Z0-9_-]+$`. Empty CLI slugs and path-containing slugs
+are rejected by `config-set` before any write.
+</step>
+
+<step name="section_3_agent_skills">
+
+`agent_skills.<agent-type>` injects extra skill names into an agent's spawn
+frontmatter. The slug is user-extensible, so input is free-text validated
+against `^[a-zA-Z0-9_-]+$`. Inputs with path separators, spaces, or shell
+metacharacters are rejected.
+
+```text
+AskUserQuestion([
+  {
+    question: "Agent skills mapping — what next?",
+    header: "Agent Skills",
+    multiSelect: false,
+    options: [
+      { label: "Configure agent", description: "Pick an agent type and set/clear skills" },
+      { label: "Done", description: "Finish this section" }
+    ]
+  }
+])
+```
+
+If "Configure agent" is selected, ask:
+
+```text
+AskUserQuestion([
+  {
+    question: "Configure agent_skills for which agent type?",
+    header: "Agent Type",
+    multiSelect: false,
+    options: [
+      { label: "gsd-executor", description: "Skills injected when spawning executor agents" },
+      { label: "gsd-planner", description: "Skills injected when spawning planner agents" },
+      { label: "gsd-verifier", description: "Skills injected when spawning verifier agents" },
+      { label: "Custom…", description: "Enter a custom agent-type slug" }
+    ]
+  }
+])
+```
+
+For "Custom…", prompt for a slug and validate it matches
+`^[a-zA-Z0-9_-]+$`. If it fails validation, print:
+
+```text
+Rejected: agent-type '<slug>' must match [a-zA-Z0-9_-]+ (no path separators,
+spaces, or shell metacharacters).
+```
+
+and re-prompt.
+
+For a selected slug, prompt for the comma-separated skill list (text input).
+Show the current value if any, offer Leave / Replace / Clear. Write via:
+
+```bash
+gsd_run query config-set agent_skills.<slug> "<skill-a,skill-b,skill-c>"
+```
+
+After each update, return to the "Agent skills mapping — what next?" question.
+Loop until "Done".
+</step>
+
+<step name="confirm">
+Display the masked confirmation table. **No plaintext API keys appear in this
+output under any circumstance.**
+
+```text
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+ GSD ► INTEGRATIONS UPDATED
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+Search Integrations
+| Field              | Value             |
+|--------------------|-------------------|
+| brave_search       | ****<last-4>      |  (or "(unset)")
+| firecrawl          | ****<last-4>      |
+| exa_search         | ****<last-4>      |
+| search_gitignored  | true | false      |
+
+Code Review CLI Routing
+| CLI         | Command                              |
+|-------------|--------------------------------------|
+| claude      | <value or (session model default)>   |
+| codex       | <value or (unset)>                   |
+| gemini      | <value or (unset)>                   |
+| opencode    | <value or (unset)>                   |
+
+Agent Skills Injection
+| Agent Type       | Skills                    |
+|------------------|---------------------------|
+| <slug>           | <skill-a, skill-b>        |
+| ...              | ...                       |
+
+Notes:
+- API keys are stored plaintext in .planning/config.json. The confirmation
+  table above never displays plaintext — keys appear as ****<last-4>.
+- Plaintext is not echoed back by this workflow, not written to any log,
+  and not displayed in error messages.
+
+Quick commands:
+- /gsd:settings — workflow toggles and model profile
+- /gsd-set-profile <profile> — switch model profile
+```
+</step>
+
+</process>
+
+<success_criteria>
+- [ ] Current config read from `$GSD_CONFIG_PATH`
+- [ ] User presented with three sections: Search Integrations, Review CLI Routing, Agent Skills Injection
+- [ ] API keys written plaintext only to `config.json`; never echoed, never logged, never displayed
+- [ ] Masked confirmation table uses `****<last-4>` for set keys and `(unset)` for null
+- [ ] `review.models.<cli>` and `agent_skills.<agent-type>` keys validated against `[a-zA-Z0-9_-]+` before write
+- [ ] Config merge preserves all keys outside the three sections this workflow owns
+</success_criteria>