dff176bfd2
Mirror of code, issues, and PRs from the upstream gsd-build/get-shit-done, which appears compromised or abandoned (maintainer unreachable since 2026-04-01; $GSD token linked to rug-pull). - Adds rebrand notice block at top of English README - Removes $GSD token badge and @gsd_foundation X badge (keeps Discord) - Renames npm packages: get-shit-done-cc -> get-shit-done-redux, @gsd-build/sdk -> @gsd-redux/sdk - Updates all repo URLs across docs, workflows, package.json, bin/ - Updates ci@gsd-build -> ci@gsd-redux in workflow git identities - Leaves CHANGELOG and .changeset/* alone (historical, time-stamped)
54 lines
1.8 KiB
Markdown
54 lines
1.8 KiB
Markdown
# @gsd-redux/sdk
|
|
|
|
TypeScript SDK for **Get Shit Done**: deterministic query/mutation handlers, plan execution, and event-stream telemetry so agents focus on judgment, not shell plumbing.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm install @gsd-redux/sdk
|
|
```
|
|
|
|
## Quickstart — programmatic
|
|
|
|
```typescript
|
|
import { GSD, createRegistry } from '@gsd-redux/sdk';
|
|
|
|
const gsd = new GSD({ projectDir: process.cwd(), sessionId: 'my-run' });
|
|
const tools = gsd.createTools();
|
|
|
|
const registry = createRegistry(gsd.eventStream, 'my-run');
|
|
const { data } = await registry.dispatch('state.json', [], process.cwd());
|
|
```
|
|
|
|
## Quickstart — CLI
|
|
|
|
From a project that depends on this package, **invoke the CLI with Node** (recommended in CI and local dev):
|
|
|
|
```bash
|
|
node ./node_modules/@gsd-redux/sdk/dist/cli.js query state.json
|
|
node ./node_modules/@gsd-redux/sdk/dist/cli.js query roadmap.analyze
|
|
```
|
|
|
|
If no native handler is registered for a command, the CLI can transparently shell out to `get-shit-done/bin/gsd-tools.cjs` (see stderr warning), unless `GSD_QUERY_FALLBACK=off`.
|
|
|
|
## What ships
|
|
|
|
| Area | Entry |
|
|
|------|--------|
|
|
| Query registry | `createRegistry()` in `src/query/index.ts` — same handlers as `gsd-sdk query` |
|
|
| Tools bridge | `GSDTools` — native dispatch with optional CJS subprocess fallback |
|
|
| Orchestrators | `PhaseRunner`, `InitRunner`, `GSD` |
|
|
| CLI | `gsd-sdk` — `query`, `run`, `init`, `auto` |
|
|
|
|
## Guides
|
|
|
|
- **Handler registry & contracts:** [`src/query/QUERY-HANDLERS.md`](src/query/QUERY-HANDLERS.md)
|
|
- **Repository docs** (when present): `docs/ARCHITECTURE.md`, `docs/CLI-TOOLS.md` at repo root
|
|
|
|
## Environment
|
|
|
|
| Variable | Purpose |
|
|
|----------|---------|
|
|
| `GSD_QUERY_FALLBACK` | `off` / `never` disables CLI fallback to `gsd-tools.cjs` for unknown commands |
|
|
| `GSD_AGENTS_DIR` | Override directory scanned for installed GSD agents (`~/.claude/agents` by default) |
|