d3a79917fa
* feat: Phase 2 caller migration — gsd-sdk query in workflows (#2122) Cherry-picked orchestration rewrites from feat/sdk-foundation (#2008, 4018fee) onto current main, resolving conflicts to keep upstream worktree guards and post-merge test gate. SDK stub registry omitted (out of Phase 2 scope per #2122). Refs: #2122 #2008 Made-with: Cursor * docs: add gsd-sdk query migration blurb Made-with: Cursor * docs(workflows): extend Phase 2 gsd-sdk query caller migration - Swap node gsd-tools.cjs for gsd-sdk query in review, plan-phase, execute-plan, ship, extract_learnings, ai-integration-phase, eval-review, next, thread - Document graphify CJS-only in gsd-planner; dual-path in CLI-TOOLS and ARCHITECTURE - Update tests: workstreams gsd-sdk path, thread frontmatter.get, workspace init.*, CRLF-safe autonomous frontmatter parse - CHANGELOG: Phase 2 caller migration scope Made-with: Cursor * docs(phase2): USER-GUIDE + remaining gsd-sdk query call sites - USER-GUIDE: dual-path CLI section; state validate/sync use full CJS path - Commands: debug (config-get+tdd), quick (security note), intel Task prompt - Agent: gsd-debug-session-manager resolve-model via jq - Workflows: milestone-summary, forensics, next, complete-milestone/verify-work (audit-open CJS notes), discuss-phase, progress, verify-phase, add/insert/remove phase, transition, manager, quick workflow; remove-phase commit without --files - Test: quick-session-management accepts frontmatter.get - CHANGELOG: Phase 2 follow-up bullet Made-with: Cursor * docs(phase2): align gsd-sdk query examples in commands and agents - init.* query names; frontmatter.get uses positional field name - state.* handlers use positional args; commit uses positional paths - CJS-only notes for from-gsd2 and graphify; learnings.query wording - CHANGELOG: Phase 2 orchestration doc pass Made-with: Cursor * docs(phase2): normalize gsd-sdk query commit to positional file paths - Strip --files from commit examples in workflows, references, commands - Keep commit-to-subrepo ... --files (separate handler) - git-planning-commit.md: document positional args - Tests: new-project commit line, state.record-session, gates CRLF, roadmap.analyze - CHANGELOG [Unreleased] Made-with: Cursor * feat(sdk): gsd-sdk query parity with gsd-tools and PR 2179 registry fixes - Route query via longest-prefix match and dotted single-token expansion; fall back to runGsdToolsQuery (same argv as node gsd-tools.cjs) for full CLI coverage. - Parse gsd-sdk query permissively so gsd-tools flags (--json, --verify, etc.) are not rejected by strict parseArgs. - resolveGsdToolsPath: honor GSD_TOOLS_PATH; prefer bundled get-shit-done copy over project .claude installs; export runGsdToolsQuery from the SDK. - Fix gsd-tools audit-open (core.output; pass object for --json JSON). - Register summary-extract as alias of summary.extract; fix audit-fix workflow to call audit-uat instead of invalid init.audit-uat (PR review). Updates QUERY-HANDLERS.md and CHANGELOG [Unreleased]. Made-with: Cursor * fix(sdk): Phase 2 scope — Trek-e review (#2179, #2122) - Remove gsd-sdk query passthrough to gsd-tools.cjs; drop GSD_TOOLS_PATH - Consolidate argv routing in resolveQueryArgv(); update USAGE and QUERY-HANDLERS - Surface @file: read failures in GSDTools.parseOutput - execute-plan: defer Task Commit Protocol to gsd-executor - stale-colon-refs: skip .planning/ and root CLAUDE.md (gitignored overlays) - CHANGELOG [Unreleased]: maintainer review and routing notes Made-with: Cursor
112 lines
4.4 KiB
Markdown
112 lines
4.4 KiB
Markdown
# Workstream Flag (`--ws`)
|
|
|
|
## Overview
|
|
|
|
The `--ws <name>` flag scopes GSD operations to a specific workstream, enabling
|
|
parallel milestone work by multiple Claude Code instances on the same codebase.
|
|
|
|
## Resolution Priority
|
|
|
|
1. `--ws <name>` flag (explicit, highest priority)
|
|
2. `GSD_WORKSTREAM` environment variable (per-instance)
|
|
3. Session-scoped active workstream pointer in temp storage (per runtime session / terminal)
|
|
4. `.planning/active-workstream` file (legacy shared fallback when no session key exists)
|
|
5. `null` — flat mode (no workstreams)
|
|
|
|
## Why session-scoped pointers exist
|
|
|
|
The shared `.planning/active-workstream` file is fundamentally unsafe when multiple
|
|
Claude/Codex instances are active on the same repo at the same time. One session can
|
|
silently repoint another session's `STATE.md`, `ROADMAP.md`, and phase paths.
|
|
|
|
GSD now prefers a session-scoped pointer keyed by runtime/session identity
|
|
(`GSD_SESSION_KEY`, `CODEX_THREAD_ID`, `CLAUDE_CODE_SSE_PORT`, terminal session IDs,
|
|
or the controlling TTY). This keeps concurrent sessions isolated while preserving
|
|
legacy compatibility for runtimes that do not expose a stable session key.
|
|
|
|
## Session Identity Resolution
|
|
|
|
When GSD resolves the session-scoped pointer in step 3 above, it uses this order:
|
|
|
|
1. Explicit runtime/session env vars such as `GSD_SESSION_KEY`, `CODEX_THREAD_ID`,
|
|
`CLAUDE_SESSION_ID`, `CLAUDE_CODE_SSE_PORT`, `OPENCODE_SESSION_ID`,
|
|
`GEMINI_SESSION_ID`, `CURSOR_SESSION_ID`, `WINDSURF_SESSION_ID`,
|
|
`TERM_SESSION_ID`, `WT_SESSION`, `TMUX_PANE`, and `ZELLIJ_SESSION_NAME`
|
|
2. `TTY` or `SSH_TTY` if the shell/runtime already exposes the terminal path
|
|
3. A single best-effort `tty` probe, but only when stdin is interactive
|
|
|
|
If none of those produce a stable identity, GSD does not keep probing. It falls
|
|
back directly to the legacy shared `.planning/active-workstream` file.
|
|
|
|
This matters in headless or stripped environments: when stdin is already
|
|
non-interactive, GSD intentionally skips shelling out to `tty` because that path
|
|
cannot discover a stable session identity and only adds avoidable failures on the
|
|
routing hot path.
|
|
|
|
## Pointer Lifecycle
|
|
|
|
Session-scoped pointers are intentionally lightweight and best-effort:
|
|
|
|
- Clearing a workstream for one session removes only that session's pointer file
|
|
- If that was the last pointer for the repo, GSD also removes the now-empty
|
|
per-project temp directory
|
|
- If sibling session pointers still exist, the temp directory is left in place
|
|
- When a pointer refers to a workstream directory that no longer exists, GSD
|
|
treats it as stale state: it removes that pointer file and resolves to `null`
|
|
until the session explicitly sets a new active workstream again
|
|
|
|
GSD does not currently run a background garbage collector for historical temp
|
|
directories. Cleanup is opportunistic at the pointer being cleared or self-healed,
|
|
and broader temp hygiene is left to OS temp cleanup or future maintenance work.
|
|
|
|
## Routing Propagation
|
|
|
|
All workflow routing commands include `${GSD_WS}` which:
|
|
- Expands to `--ws <name>` when a workstream is active
|
|
- Expands to empty string in flat mode (backward compatible)
|
|
|
|
This ensures workstream scope chains automatically through the workflow:
|
|
`new-milestone → discuss-phase → plan-phase → execute-phase → transition`
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
.planning/
|
|
├── PROJECT.md # Shared
|
|
├── config.json # Shared
|
|
├── milestones/ # Shared
|
|
├── codebase/ # Shared
|
|
├── active-workstream # Legacy shared fallback only
|
|
└── workstreams/
|
|
├── feature-a/ # Workstream A
|
|
│ ├── STATE.md
|
|
│ ├── ROADMAP.md
|
|
│ ├── REQUIREMENTS.md
|
|
│ └── phases/
|
|
└── feature-b/ # Workstream B
|
|
├── STATE.md
|
|
├── ROADMAP.md
|
|
├── REQUIREMENTS.md
|
|
└── phases/
|
|
```
|
|
|
|
## CLI Usage
|
|
|
|
```bash
|
|
# All gsd-sdk query commands accept --ws
|
|
gsd-sdk query state.json --ws feature-a
|
|
gsd-sdk query find-phase 3 --ws feature-b
|
|
|
|
# Session-local switching without --ws on every command
|
|
GSD_SESSION_KEY=my-terminal-a gsd-sdk query workstream.set feature-a
|
|
GSD_SESSION_KEY=my-terminal-a gsd-sdk query state.json
|
|
GSD_SESSION_KEY=my-terminal-b gsd-sdk query workstream.set feature-b
|
|
GSD_SESSION_KEY=my-terminal-b gsd-sdk query state.json
|
|
|
|
# Workstream CRUD
|
|
gsd-sdk query workstream.create <name>
|
|
gsd-sdk query workstream.list
|
|
gsd-sdk query workstream.status <name>
|
|
gsd-sdk query workstream.complete <name>
|
|
```
|