mirror of
https://github.com/glittercowboy/get-shit-done
synced 2026-04-25 17:25:23 +02:00
docs: update README and documentation for v1.25 release (#1090)
- Add Antigravity to verify instructions and uninstall commands - Add Gemini to uninstall commands (was missing) - Add hooks.context_warnings config to README and CONFIGURATION.md - Add /gsd:note command documentation to COMMANDS.md - Add Note Capture feature (section 13) to FEATURES.md - Renumber subsequent feature sections (14-33)
This commit is contained in:
Tom Boucher
3
.gitignore
vendored
3
.gitignore
vendored
@@ -35,4 +35,5 @@ philosophy.md
|
||||
.github/skills/gsd-*
|
||||
.github/get-shit-done/*
|
||||
.github/skills/get-shit-done
|
||||
.github/copilot-instructions.md
|
||||
.github/copilot-instructions.md
|
||||
.bg-shell/
|
||||
|
||||
@@ -90,6 +90,7 @@ Verify with:
|
||||
- OpenCode: `/gsd-help`
|
||||
- Codex: `$gsd-help`
|
||||
- Copilot: `/gsd:help`
|
||||
- Antigravity: `/gsd:help`
|
||||
|
||||
> [!NOTE]
|
||||
> Codex installation uses skills (`skills/gsd-*/SKILL.md`) rather than custom prompts.
|
||||
@@ -604,6 +605,7 @@ Use `/gsd:settings` to toggle these, or override per-invocation:
|
||||
|---------|---------|------------------|
|
||||
| `parallelization.enabled` | `true` | Run independent plans simultaneously |
|
||||
| `planning.commit_docs` | `true` | Track `.planning/` in git |
|
||||
| `hooks.context_warnings` | `true` | Show context window usage warnings |
|
||||
|
||||
### Git Branching
|
||||
|
||||
@@ -687,14 +689,17 @@ To remove GSD completely:
|
||||
# Global installs
|
||||
npx get-shit-done-cc --claude --global --uninstall
|
||||
npx get-shit-done-cc --opencode --global --uninstall
|
||||
npx get-shit-done-cc --gemini --global --uninstall
|
||||
npx get-shit-done-cc --codex --global --uninstall
|
||||
npx get-shit-done-cc --copilot --global --uninstall
|
||||
npx get-shit-done-cc --antigravity --global --uninstall
|
||||
|
||||
# Local installs (current project)
|
||||
npx get-shit-done-cc --claude --local --uninstall
|
||||
npx get-shit-done-cc --opencode --local --uninstall
|
||||
npx get-shit-done-cc --codex --local --uninstall
|
||||
npx get-shit-done-cc --copilot --local --uninstall
|
||||
npx get-shit-done-cc --antigravity --local --uninstall
|
||||
```
|
||||
|
||||
This removes all GSD commands, agents, hooks, and settings while preserving your other configurations.
|
||||
|
||||
@@ -352,6 +352,26 @@ Route freeform text to the right GSD command.
|
||||
/gsd:do # Then describe what you want
|
||||
```
|
||||
|
||||
### `/gsd:note`
|
||||
|
||||
Zero-friction idea capture — append, list, or promote notes to todos.
|
||||
|
||||
| Argument | Required | Description |
|
||||
|----------|----------|-------------|
|
||||
| `text` | No | Note text to capture (default: append mode) |
|
||||
| `list` | No | List all notes from project and global scopes |
|
||||
| `promote N` | No | Convert note N into a structured todo |
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `--global` | Use global scope for note operations |
|
||||
|
||||
```bash
|
||||
/gsd:note "Consider caching strategy for API responses"
|
||||
/gsd:note list
|
||||
/gsd:note promote 3
|
||||
```
|
||||
|
||||
### `/gsd:debug`
|
||||
|
||||
Systematic debugging with persistent state.
|
||||
|
||||
@@ -196,6 +196,14 @@ Control confirmation prompts during workflows.
|
||||
|
||||
---
|
||||
|
||||
## Hook Settings
|
||||
|
||||
| Setting | Type | Default | Description |
|
||||
|---------|------|---------|-------------|
|
||||
| `hooks.context_warnings` | boolean | `true` | Show context window usage warnings during sessions |
|
||||
|
||||
---
|
||||
|
||||
## Model Profiles
|
||||
|
||||
### Profile Definitions
|
||||
|
||||
@@ -370,9 +370,24 @@
|
||||
|
||||
---
|
||||
|
||||
### 13. Note Capture
|
||||
|
||||
**Command:** `/gsd:note`
|
||||
|
||||
**Purpose:** Zero-friction idea capture without interrupting workflow. Append timestamped notes, list all notes, or promote notes to structured todos.
|
||||
|
||||
**Requirements:**
|
||||
- REQ-NOTE-01: System MUST save timestamped note files with a single Write call
|
||||
- REQ-NOTE-02: System MUST support `list` subcommand to show all notes from project and global scopes
|
||||
- REQ-NOTE-03: System MUST support `promote N` subcommand to convert a note into a structured todo
|
||||
- REQ-NOTE-04: System MUST support `--global` flag for global scope operations
|
||||
- REQ-NOTE-05: System MUST NOT use Task, AskUserQuestion, or Bash — runs inline only
|
||||
|
||||
---
|
||||
|
||||
## Quality Assurance Features
|
||||
|
||||
### 13. Nyquist Validation
|
||||
### 14. Nyquist Validation
|
||||
|
||||
**Purpose:** Map automated test coverage to phase requirements before any code is written. Named after the Nyquist sampling theorem — ensures a feedback signal exists for every requirement.
|
||||
|
||||
@@ -395,7 +410,7 @@
|
||||
|
||||
---
|
||||
|
||||
### 14. Plan Checking
|
||||
### 15. Plan Checking
|
||||
|
||||
**Purpose:** Goal-backward verification that plans will achieve phase objectives before execution.
|
||||
|
||||
@@ -407,7 +422,7 @@
|
||||
|
||||
---
|
||||
|
||||
### 15. Post-Execution Verification
|
||||
### 16. Post-Execution Verification
|
||||
|
||||
**Purpose:** Automated check that the codebase delivers what the phase promised.
|
||||
|
||||
@@ -419,7 +434,7 @@
|
||||
|
||||
---
|
||||
|
||||
### 16. Node Repair
|
||||
### 17. Node Repair
|
||||
|
||||
**Purpose:** Autonomous recovery when task verification fails during execution.
|
||||
|
||||
@@ -433,7 +448,7 @@
|
||||
|
||||
---
|
||||
|
||||
### 17. Health Validation
|
||||
### 18. Health Validation
|
||||
|
||||
**Command:** `/gsd:health [--repair]`
|
||||
|
||||
@@ -450,7 +465,7 @@
|
||||
|
||||
## Context Engineering Features
|
||||
|
||||
### 18. Context Window Monitoring
|
||||
### 19. Context Window Monitoring
|
||||
|
||||
**Purpose:** Prevent context rot by alerting both user and agent when context is running low.
|
||||
|
||||
@@ -470,7 +485,7 @@
|
||||
|
||||
---
|
||||
|
||||
### 19. Session Management
|
||||
### 20. Session Management
|
||||
|
||||
**Commands:** `/gsd:pause-work`, `/gsd:resume-work`, `/gsd:progress`
|
||||
|
||||
@@ -485,7 +500,7 @@
|
||||
|
||||
---
|
||||
|
||||
### 20. Multi-Agent Orchestration
|
||||
### 21. Multi-Agent Orchestration
|
||||
|
||||
**Purpose:** Coordinate specialized agents with fresh context windows for each task.
|
||||
|
||||
@@ -499,7 +514,7 @@
|
||||
|
||||
---
|
||||
|
||||
### 21. Model Profiles
|
||||
### 22. Model Profiles
|
||||
|
||||
**Command:** `/gsd:set-profile <quality|balanced|budget|inherit>`
|
||||
|
||||
@@ -534,7 +549,7 @@
|
||||
|
||||
## Brownfield Features
|
||||
|
||||
### 22. Codebase Mapping
|
||||
### 23. Codebase Mapping
|
||||
|
||||
**Command:** `/gsd:map-codebase [area]`
|
||||
|
||||
@@ -562,7 +577,7 @@
|
||||
|
||||
## Utility Features
|
||||
|
||||
### 23. Debug System
|
||||
### 24. Debug System
|
||||
|
||||
**Command:** `/gsd:debug [description]`
|
||||
|
||||
@@ -580,7 +595,7 @@
|
||||
|
||||
---
|
||||
|
||||
### 24. Todo Management
|
||||
### 25. Todo Management
|
||||
|
||||
**Commands:** `/gsd:add-todo [desc]`, `/gsd:check-todos`
|
||||
|
||||
@@ -594,7 +609,7 @@
|
||||
|
||||
---
|
||||
|
||||
### 25. Statistics Dashboard
|
||||
### 26. Statistics Dashboard
|
||||
|
||||
**Command:** `/gsd:stats`
|
||||
|
||||
@@ -608,7 +623,7 @@
|
||||
|
||||
---
|
||||
|
||||
### 26. Update System
|
||||
### 27. Update System
|
||||
|
||||
**Command:** `/gsd:update`
|
||||
|
||||
@@ -623,7 +638,7 @@
|
||||
|
||||
---
|
||||
|
||||
### 27. Settings Management
|
||||
### 28. Settings Management
|
||||
|
||||
**Command:** `/gsd:settings`
|
||||
|
||||
@@ -656,7 +671,7 @@
|
||||
|
||||
---
|
||||
|
||||
### 28. Test Generation
|
||||
### 29. Test Generation
|
||||
|
||||
**Command:** `/gsd:add-tests [N]`
|
||||
|
||||
@@ -671,7 +686,7 @@
|
||||
|
||||
## Infrastructure Features
|
||||
|
||||
### 29. Git Integration
|
||||
### 30. Git Integration
|
||||
|
||||
**Purpose:** Atomic commits, branching strategies, and clean history management.
|
||||
|
||||
@@ -697,7 +712,7 @@ fix(03-01): correct auth token expiry
|
||||
|
||||
---
|
||||
|
||||
### 30. CLI Tools
|
||||
### 31. CLI Tools
|
||||
|
||||
**Purpose:** Programmatic utilities for workflows and agents, replacing repetitive inline bash patterns.
|
||||
|
||||
@@ -712,7 +727,7 @@ fix(03-01): correct auth token expiry
|
||||
|
||||
---
|
||||
|
||||
### 31. Multi-Runtime Support
|
||||
### 32. Multi-Runtime Support
|
||||
|
||||
**Purpose:** Run GSD across 6 different AI coding agent runtimes.
|
||||
|
||||
@@ -735,7 +750,7 @@ fix(03-01): correct auth token expiry
|
||||
|
||||
---
|
||||
|
||||
### 32. Hook System
|
||||
### 33. Hook System
|
||||
|
||||
**Purpose:** Runtime event hooks for context monitoring, status display, and update checking.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user