* 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 `<!--` cannot survive (js/incomplete-multi-character-sanitization). - tests/inline-plan-threshold: drop the no-op `\s`->`\s` identity replace, keep the meaningful POSIX-class conversion (js/identity-replacement). Verified: build:lib green; the touched test files + ci-test-scope + profile-output suites pass; lint:legacy-name clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): correctly resolve remaining CodeQL alerts (regex-injection + sanitization) The prior commit's fixes for two alerts were ineffective: - ci-test-scope.cjs js/regex-injection: the alert is the CLI-arg-derived `file` reaching static regex `.test(file)` calls (not the config rule). Removed ALL regex over file/t — startsWith/includes/=== string checks + an isWindowsHint helper — so there is no regex sink for the tainted value. - js/incomplete-multi-character-sanitization (3 test files): a single `.replace(/<!--...-->/g,'')` can let `<!--` re-form. Replaced with a fixpoint loop (replace until stable) plus a final bare-opener strip. Verified: no regex over file/t remains; ci-test-scope + the 3 test suites pass; lint:legacy-name clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * fix(#604): make ci-test-scope + comment-strippers regex-free to clear CodeQL CodeQL flags the regex PATTERNS syntactically (regex-injection on the --files arg split; incomplete-multi-character-sanitization on the <!--...--> 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>
502 lines
17 KiB
Markdown
502 lines
17 KiB
Markdown
# GSD CLI Tools Reference
|
|
|
|
> Reference for the `gsd-tools` CLI (`gsd-core/bin/gsd-tools.cjs`). For slash commands and user flows, see [Command Reference](COMMANDS.md). Return to [docs index](README.md).
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
`gsd-tools.cjs` centralizes config parsing, model resolution, phase lookup, git commits, summary verification, state management, and template operations across GSD commands, workflows, and agents.
|
|
|
|
|
|
| | |
|
|
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| **Shipped path** | `gsd-core/bin/gsd-tools.cjs` |
|
|
| **Implementation** | 20 domain modules under `gsd-core/bin/lib/` (the directory is authoritative) |
|
|
| **Status** | Primary runtime command surface for orchestration, workflows, and automation. |
|
|
|
|
|
|
**Usage (CJS):**
|
|
|
|
```bash
|
|
node gsd-tools.cjs <command> [args] [--raw] [--cwd <path>]
|
|
```
|
|
|
|
**Global flags (CJS):**
|
|
|
|
|
|
| Flag | Description |
|
|
| -------------- | ---------------------------------------------------------------------------- |
|
|
| `--raw` | Machine-readable output (JSON or plain text, no formatting) |
|
|
| `--cwd <path>` | Override working directory (for sandboxed subagents) |
|
|
| `--ws <name>` | Workstream context for `.planning/workstreams/<name>` paths |
|
|
|
|
|
|
---
|
|
|
|
## State Commands
|
|
|
|
Manage `.planning/STATE.md` — the project's living memory.
|
|
|
|
```bash
|
|
# Load full project config + state as JSON
|
|
node gsd-tools.cjs state load
|
|
|
|
# Output STATE.md frontmatter as JSON
|
|
node gsd-tools.cjs state json
|
|
|
|
# Update a single field
|
|
node gsd-tools.cjs state update <field> <value>
|
|
|
|
# Get STATE.md content or a specific section
|
|
node gsd-tools.cjs state get [section]
|
|
|
|
# Batch update multiple fields
|
|
node gsd-tools.cjs state patch --field1 val1 --field2 val2
|
|
|
|
# Increment plan counter
|
|
node gsd-tools.cjs state advance-plan
|
|
|
|
# Record execution metrics
|
|
node gsd-tools.cjs state record-metric --phase N --plan M --duration Xmin [--tasks N] [--files N]
|
|
|
|
# Recalculate progress bar
|
|
node gsd-tools.cjs state update-progress
|
|
|
|
# Add a decision
|
|
node gsd-tools.cjs state add-decision --summary "..." [--phase N] [--rationale "..."]
|
|
# Or from files:
|
|
node gsd-tools.cjs state add-decision --summary-file path [--rationale-file path]
|
|
|
|
# Add/resolve blockers
|
|
node gsd-tools.cjs state add-blocker --text "..."
|
|
node gsd-tools.cjs state resolve-blocker --text "..."
|
|
|
|
# Record session continuity
|
|
node gsd-tools.cjs state record-session --stopped-at "..." [--resume-file path]
|
|
|
|
# Phase start — update STATE.md Status/Last activity for a new phase
|
|
node gsd-tools.cjs state begin-phase --phase N --name SLUG --plans COUNT
|
|
|
|
# Agent-discoverable blocker signalling (used by discuss-phase / UI flows)
|
|
node gsd-tools.cjs state signal-waiting --type TYPE --question "..." --options "A|B" --phase P
|
|
node gsd-tools.cjs state signal-resume
|
|
```
|
|
|
|
### State Snapshot
|
|
|
|
Structured parse of the full STATE.md:
|
|
|
|
```bash
|
|
node gsd-tools.cjs state-snapshot
|
|
```
|
|
|
|
Returns JSON with: current position, phase, plan, status, decisions, blockers, metrics, last activity.
|
|
|
|
---
|
|
|
|
## Phase Commands
|
|
|
|
Manage phases — directories, numbering, and roadmap sync.
|
|
|
|
```bash
|
|
# Find phase directory by number
|
|
node gsd-tools.cjs find-phase <phase>
|
|
|
|
# Calculate next decimal phase number for insertions
|
|
node gsd-tools.cjs phase next-decimal <phase>
|
|
|
|
# Append new phase to roadmap + create directory
|
|
node gsd-tools.cjs phase add <description>
|
|
|
|
# Insert decimal phase after existing
|
|
node gsd-tools.cjs phase insert <after> <description>
|
|
|
|
# Remove phase, renumber subsequent
|
|
node gsd-tools.cjs phase remove <phase> [--force]
|
|
|
|
# Mark phase complete, update state + roadmap
|
|
node gsd-tools.cjs phase complete <phase>
|
|
|
|
# Index plans with waves and status
|
|
node gsd-tools.cjs phase-plan-index <phase>
|
|
|
|
# List phases with filtering
|
|
node gsd-tools.cjs phases list [--type planned|executed|all] [--phase N] [--include-archived]
|
|
```
|
|
|
|
---
|
|
|
|
## Roadmap Commands
|
|
|
|
Parse and update `ROADMAP.md`.
|
|
|
|
```bash
|
|
# Extract phase section from ROADMAP.md
|
|
node gsd-tools.cjs roadmap get-phase <phase>
|
|
|
|
# Full roadmap parse with disk status
|
|
node gsd-tools.cjs roadmap analyze
|
|
|
|
# Update progress table row from disk
|
|
node gsd-tools.cjs roadmap update-plan-progress <N>
|
|
```
|
|
|
|
---
|
|
|
|
## Config Commands
|
|
|
|
Read and write `.planning/config.json`.
|
|
|
|
```bash
|
|
# Initialize config.json with defaults
|
|
node gsd-tools.cjs config-ensure-section
|
|
|
|
# Set a config value (dot notation)
|
|
node gsd-tools.cjs config-set <key> <value>
|
|
|
|
# Get a config value
|
|
node gsd-tools.cjs config-get <key>
|
|
|
|
# Set model profile
|
|
node gsd-tools.cjs config-set-model-profile <profile>
|
|
```
|
|
|
|
---
|
|
|
|
## Model Resolution
|
|
|
|
```bash
|
|
# Get model for agent based on current profile
|
|
node gsd-tools.cjs resolve-model <agent-name>
|
|
# Raw output returns the selected model ID/tier.
|
|
# JSON output also includes profile and, when the active runtime supports it,
|
|
# reasoning_effort.
|
|
```
|
|
|
|
Agent names: `gsd-planner`, `gsd-executor`, `gsd-phase-researcher`, `gsd-project-researcher`, `gsd-research-synthesizer`, `gsd-verifier`, `gsd-plan-checker`, `gsd-integration-checker`, `gsd-roadmapper`, `gsd-debugger`, `gsd-codebase-mapper`, `gsd-nyquist-auditor`
|
|
|
|
---
|
|
|
|
## Verification Commands
|
|
|
|
Validate plans, phases, references, and commits.
|
|
|
|
```bash
|
|
# Verify SUMMARY.md file
|
|
node gsd-tools.cjs verify-summary <path> [--check-count N]
|
|
|
|
# Check PLAN.md structure + tasks
|
|
node gsd-tools.cjs verify plan-structure <file>
|
|
|
|
# Check all plans have summaries
|
|
node gsd-tools.cjs verify phase-completeness <phase>
|
|
|
|
# Check @-refs + paths resolve
|
|
node gsd-tools.cjs verify references <file>
|
|
|
|
# Batch verify commit hashes
|
|
node gsd-tools.cjs verify commits <hash1> [hash2] ...
|
|
|
|
# Check must_haves.artifacts
|
|
node gsd-tools.cjs verify artifacts <plan-file>
|
|
|
|
# Check must_haves.key_links
|
|
node gsd-tools.cjs verify key-links <plan-file>
|
|
```
|
|
|
|
---
|
|
|
|
## Validation Commands
|
|
|
|
Check project integrity.
|
|
|
|
```bash
|
|
# Check phase numbering, disk/roadmap sync
|
|
node gsd-tools.cjs validate consistency
|
|
|
|
# Check .planning/ integrity, optionally repair
|
|
node gsd-tools.cjs validate health [--repair]
|
|
|
|
# Probe context-window utilization for status-line / hook callers (v1.40.0)
|
|
node gsd-tools.cjs validate context
|
|
|
|
# Context utilization as typed JSON surface (#455)
|
|
node gsd-tools.cjs validate context --json
|
|
```
|
|
|
|
`validate context` emits a structured envelope with `utilization`, `status`
|
|
(`ok` / `warn` / `critical` at the 60 % / 70 % thresholds), and a
|
|
`suggestion` string. The same data backs `/gsd-health --context`.
|
|
Pass `--json` to receive the typed IR directly (useful in scripts and test assertions).
|
|
|
|
---
|
|
|
|
## Template Commands
|
|
|
|
Template selection and filling.
|
|
|
|
```bash
|
|
# Select summary template based on granularity
|
|
node gsd-tools.cjs template select <type>
|
|
|
|
# Fill template with variables
|
|
node gsd-tools.cjs template fill <type> --phase N [--plan M] [--name "..."] [--type execute|tdd] [--wave N] [--fields '{json}']
|
|
```
|
|
|
|
Template types for `fill`: `summary`, `plan`, `verification`
|
|
|
|
---
|
|
|
|
## Frontmatter Commands
|
|
|
|
YAML frontmatter CRUD operations on any Markdown file.
|
|
|
|
```bash
|
|
# Extract frontmatter as JSON
|
|
node gsd-tools.cjs frontmatter get <file> [--field key]
|
|
|
|
# Update single field
|
|
node gsd-tools.cjs frontmatter set <file> --field key --value jsonVal
|
|
|
|
# Merge JSON into frontmatter
|
|
node gsd-tools.cjs frontmatter merge <file> --data '{json}'
|
|
|
|
# Validate required fields
|
|
node gsd-tools.cjs frontmatter validate <file> --schema plan|summary|verification
|
|
```
|
|
|
|
---
|
|
|
|
## Scaffold Commands
|
|
|
|
Create pre-structured files and directories.
|
|
|
|
```bash
|
|
# Create CONTEXT.md template
|
|
node gsd-tools.cjs scaffold context --phase N
|
|
|
|
# Create UAT.md template
|
|
node gsd-tools.cjs scaffold uat --phase N
|
|
|
|
# Create VERIFICATION.md template
|
|
node gsd-tools.cjs scaffold verification --phase N
|
|
|
|
# Create phase directory
|
|
node gsd-tools.cjs scaffold phase-dir --phase N --name "phase name"
|
|
```
|
|
|
|
---
|
|
|
|
## Init Commands (Compound Context Loading)
|
|
|
|
Load all context needed for a specific workflow in one call. Returns JSON with project info, config, state, and workflow-specific data.
|
|
|
|
```bash
|
|
node gsd-tools.cjs init execute-phase <phase>
|
|
node gsd-tools.cjs init plan-phase <phase>
|
|
node gsd-tools.cjs init new-project
|
|
node gsd-tools.cjs init new-milestone
|
|
node gsd-tools.cjs init quick <description>
|
|
node gsd-tools.cjs init resume
|
|
node gsd-tools.cjs init verify-work <phase>
|
|
node gsd-tools.cjs init phase-op <phase>
|
|
node gsd-tools.cjs init todos [area]
|
|
node gsd-tools.cjs init milestone-op
|
|
node gsd-tools.cjs init map-codebase
|
|
node gsd-tools.cjs init progress
|
|
|
|
# Workstream-scoped init (`--ws` flag)
|
|
node gsd-tools.cjs init execute-phase <phase> --ws <name>
|
|
node gsd-tools.cjs init plan-phase <phase> --ws <name>
|
|
```
|
|
|
|
**Large payload handling:** When output exceeds ~50KB, the CLI writes to a temp file and returns `@file:/tmp/gsd-init-XXXXX.json`. Workflows check for the `@file:` prefix and read from disk:
|
|
|
|
```bash
|
|
INIT=$(node gsd-tools.cjs init execute-phase "1")
|
|
if [[ "$INIT" == @file:* ]]; then INIT=$(cat "${INIT#@file:}"); fi
|
|
```
|
|
|
|
---
|
|
|
|
## Milestone Commands
|
|
|
|
```bash
|
|
# Archive milestone
|
|
node gsd-tools.cjs milestone complete <version> [--name <name>] [--archive-phases]
|
|
|
|
# Mark requirements as complete
|
|
node gsd-tools.cjs requirements mark-complete <ids>
|
|
# Accepts: REQ-01,REQ-02 or REQ-01 REQ-02 or [REQ-01, REQ-02]
|
|
```
|
|
|
|
---
|
|
|
|
## Agent Skills
|
|
|
|
Emit the skill block for a given agent type.
|
|
|
|
```bash
|
|
# Emit raw XML skill block (default — safe for shell expansion)
|
|
node gsd-tools.cjs agent-skills <agent-type>
|
|
|
|
# Emit typed JSON surface (#455) — { agent_type, block, skills_count }
|
|
node gsd-tools.cjs agent-skills <agent-type> --json
|
|
```
|
|
|
|
The `--json` flag returns a typed IR object suitable for structured consumption and test assertions, while the default (no flag) preserves the raw XML output that workflow shell expansions rely on.
|
|
|
|
---
|
|
|
|
## Skill Manifest
|
|
|
|
Pre-compute and cache skill discovery for faster command loading.
|
|
|
|
```bash
|
|
# Generate skill manifest (writes to .claude/skill-manifest.json)
|
|
node gsd-tools.cjs skill-manifest
|
|
|
|
# Generate with custom output path
|
|
node gsd-tools.cjs skill-manifest --output <path>
|
|
```
|
|
|
|
Returns JSON mapping of all available GSD skills with their metadata (name, description, file path, argument hints). Used by the installer and session-start hooks to avoid repeated filesystem scans.
|
|
|
|
---
|
|
|
|
## Utility Commands
|
|
|
|
```bash
|
|
# Convert text to URL-safe slug
|
|
node gsd-tools.cjs generate-slug "Some Text Here"
|
|
# → some-text-here
|
|
|
|
# Get timestamp
|
|
node gsd-tools.cjs current-timestamp [full|date|filename]
|
|
|
|
# Count and list pending todos
|
|
node gsd-tools.cjs list-todos [area]
|
|
|
|
# Check file/directory existence
|
|
node gsd-tools.cjs verify-path-exists <path>
|
|
|
|
# Aggregate all SUMMARY.md data
|
|
node gsd-tools.cjs history-digest
|
|
|
|
# Extract structured data from SUMMARY.md
|
|
node gsd-tools.cjs summary-extract <path> [--fields field1,field2]
|
|
|
|
# Project statistics
|
|
node gsd-tools.cjs stats [json|table]
|
|
|
|
# Progress rendering (human-readable)
|
|
node gsd-tools.cjs progress [json|table|bar]
|
|
|
|
# Progress as typed JSON surface (#455)
|
|
node gsd-tools.cjs progress --json
|
|
|
|
# Complete a todo
|
|
node gsd-tools.cjs todo complete <filename>
|
|
|
|
# UAT audit — scan all phases for unresolved items
|
|
node gsd-tools.cjs audit-uat
|
|
|
|
# Cross-artifact audit queue — scan `.planning/` for unresolved audit items
|
|
node gsd-tools.cjs audit-open [--json]
|
|
|
|
# Reverse-migrate a GSD-2 project into the current structure (backs `/gsd-import --from-gsd2`)
|
|
node gsd-tools.cjs from-gsd2 [--path <dir>] [--force] [--dry-run]
|
|
|
|
# Git commit with config checks
|
|
node gsd-tools.cjs commit <message> [--files f1 f2] [--amend] [--no-verify] [--respect-staged]
|
|
```
|
|
|
|
> `--no-verify`: Skips pre-commit hooks. Used by parallel executor agents during wave-based execution to avoid build lock contention (e.g., cargo lock fights in Rust projects). The orchestrator runs hooks once after each wave completes. Do not use `--no-verify` during sequential execution — let hooks run normally.
|
|
> `--files <paths>` **staging behaviour**: by default, `--files` runs `git add -- <path>` for each named file before committing. This overwrites any per-hunk staging set up via `git add -p`. Pass `--respect-staged` to skip the `git add` step and commit only what is already in the index within the requested pathspec. If nothing is staged within that scope, the command returns `{ committed: false, reason: 'nothing staged' }` without error. The trailing `-- <paths>` pathspec on the commit is applied under both modes, so files staged outside the `--files` scope are never included (#3061 invariant).
|
|
|
|
# Web search (requires Brave API key)
|
|
node gsd-tools.cjs websearch <query> [--limit N] [--freshness day|week|month]
|
|
```
|
|
|
|
---
|
|
|
|
## Graphify
|
|
|
|
Build, query, and inspect the project knowledge graph in `.planning/graphs/`. Requires `graphify.enabled: true` in `config.json` (see [Configuration Reference](CONFIGURATION.md#graphify-settings)).
|
|
|
|
```bash
|
|
# Build or rebuild the knowledge graph
|
|
node gsd-tools.cjs graphify build
|
|
|
|
# Search the graph for a term
|
|
node gsd-tools.cjs graphify query <term>
|
|
|
|
# Show graph freshness and statistics
|
|
node gsd-tools.cjs graphify status
|
|
|
|
# Show changes since the last build
|
|
node gsd-tools.cjs graphify diff
|
|
|
|
# Write a named snapshot of the current graph
|
|
node gsd-tools.cjs graphify snapshot [name]
|
|
```
|
|
|
|
User-facing entry point: `/gsd-graphify` (see [Command Reference](COMMANDS.md#gsd-graphify)).
|
|
|
|
---
|
|
|
|
## Module Architecture
|
|
|
|
| Module | File | Exports |
|
|
|--------|------|---------|
|
|
| Core | `lib/core.cjs` | `error()`, `output()`, `parseArgs()`, shared utilities, compatibility re-exports |
|
|
| State | `lib/state.cjs` | All `state` subcommands, `state-snapshot` |
|
|
| Phase | `lib/phase.cjs` | Phase CRUD, `find-phase`, `phase-plan-index`, `phases list` |
|
|
| Planning Workspace | `lib/planning-workspace.cjs` | Planning seam: `planningDir`, `planningPaths`, active workstream routing, `.planning/.lock` |
|
|
| Roadmap | `lib/roadmap.cjs` | Roadmap parsing, phase extraction, progress updates |
|
|
| Config | `lib/config.cjs` | Config read/write, section initialization |
|
|
| Verify | `lib/verify.cjs` | All verification and validation commands |
|
|
| Template | `lib/template.cjs` | Template selection and variable filling |
|
|
| Frontmatter | `lib/frontmatter.cjs` | YAML frontmatter CRUD |
|
|
| Init | `lib/init.cjs` | Compound context loading for all workflows |
|
|
| Milestone | `lib/milestone.cjs` | Milestone archival, requirements marking |
|
|
| Commands | `lib/commands.cjs` | Misc: slug, timestamp, todos, scaffold, stats, websearch |
|
|
| Model Profiles | `lib/model-profiles.cjs` | Profile resolution table |
|
|
| UAT | `lib/uat.cjs` | Cross-phase UAT/verification audit |
|
|
| Profile Output | `lib/profile-output.cjs` | Developer profile formatting |
|
|
| Profile Pipeline | `lib/profile-pipeline.cjs` | Session analysis pipeline |
|
|
| Graphify | `lib/graphify.cjs` | Knowledge graph build/query/status/diff/snapshot (backs `/gsd-graphify`) |
|
|
| Learnings | `lib/learnings.cjs` | Extract learnings from phases/SUMMARY artifacts (backs `/gsd-extract-learnings`) |
|
|
| Audit | `lib/audit.cjs` | Phase/milestone audit queue handlers; `audit-open` helper |
|
|
| GSD2 Import | `lib/gsd2-import.cjs` | Reverse-migration importer from GSD-2 projects (backs `/gsd-import --from-gsd2`) |
|
|
| Intel | `lib/intel.cjs` | Queryable codebase intelligence index (backs `/gsd-map-codebase --query`) |
|
|
|
|
---
|
|
|
|
## Reviewer CLI Routing
|
|
|
|
`review.models.<cli>` maps a reviewer flavor to a shell command invoked by the code-review workflow. Set via [`/gsd-config --integrations`](COMMANDS.md#gsd-config) or directly:
|
|
|
|
```bash
|
|
node gsd-tools.cjs config-set review.models.codex "codex exec --model gpt-5"
|
|
node gsd-tools.cjs config-set review.models.gemini "gemini -m gemini-2.5-pro"
|
|
node gsd-tools.cjs config-set review.models.opencode "opencode run --model claude-sonnet-4"
|
|
node gsd-tools.cjs config-set review.models.claude "" # clear — fall back to session model
|
|
```
|
|
|
|
Slugs are validated against `[a-zA-Z0-9_-]+`; empty or path-containing slugs are rejected. See [`docs/CONFIGURATION.md`](CONFIGURATION.md#code-review-cli-routing) for the full field reference.
|
|
|
|
## Secret Handling
|
|
|
|
API keys configured via `/gsd-settings` (`brave_search`, `firecrawl`, `exa_search`) are written plaintext to `.planning/config.json` but are masked (`****<last-4>`) in every `config-set` / `config-get` output, confirmation table, and interactive prompt. See `gsd-core/bin/lib/secrets.cjs` for the masking implementation. The `config.json` file itself is the security boundary — protect it with filesystem permissions and keep it out of git (`.planning/` is gitignored by default).
|
|
|
|
---
|
|
|
|
## Related
|
|
|
|
- [Commands](COMMANDS.md)
|
|
- [Configuration](CONFIGURATION.md)
|
|
- [Architecture](ARCHITECTURE.md)
|
|
- [docs index](README.md)
|