mirror of
https://github.com/glittercowboy/get-shit-done
synced 2026-04-26 01:35:29 +02:00
b602c1ddc7
Community PRs repeatedly add marketing commentary in parentheses next to product names (licensing model, parent company, architecture). Product listings should contain only the product name. Cleaned across 8 files in 5 languages (EN, KO, JA, ZH, PT) plus install.js code comments and CHANGELOG. Added static analysis guard test that prevents this pattern from recurring. Fixes #1777 Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
491 lines
16 KiB
Markdown
491 lines
16 KiB
Markdown
<div align="center">
|
|
|
|
# GET SHIT DONE
|
|
|
|
[English](README.md) · **Português** · [简体中文](README.zh-CN.md) · [日本語](README.ja-JP.md)
|
|
|
|
**Um sistema leve e poderoso de meta-prompting, engenharia de contexto e desenvolvimento orientado a especificação para Claude Code, OpenCode, Gemini CLI, Kilo, Codex, Copilot, Cursor, Windsurf, Antigravity, Augment, Trae e Cline.**
|
|
|
|
**Resolve context rot — a degradação de qualidade que acontece conforme o Claude enche a janela de contexto.**
|
|
|
|
[](https://www.npmjs.com/package/get-shit-done-cc)
|
|
[](https://www.npmjs.com/package/get-shit-done-cc)
|
|
[](https://github.com/gsd-build/get-shit-done/actions/workflows/test.yml)
|
|
[](https://discord.gg/mYgfVNfA2r)
|
|
[](https://x.com/gsd_foundation)
|
|
[](https://dexscreener.com/solana/dwudwjvan7bzkw9zwlbyv6kspdlvhwzrqy6ebk8xzxkv)
|
|
[](https://github.com/gsd-build/get-shit-done)
|
|
[](LICENSE)
|
|
|
|
<br>
|
|
|
|
```bash
|
|
npx get-shit-done-cc@latest
|
|
```
|
|
|
|
**Funciona em Mac, Windows e Linux.**
|
|
|
|
<br>
|
|
|
|
|
|
|
|
<br>
|
|
|
|
*"Se você sabe claramente o que quer, isso VAI construir para você. Sem enrolação."*
|
|
|
|
*"Eu já usei SpecKit, OpenSpec e Taskmaster — este me deu os melhores resultados."*
|
|
|
|
*"De longe a adição mais poderosa ao meu Claude Code. Nada superengenheirado. Simplesmente faz o trabalho."*
|
|
|
|
<br>
|
|
|
|
**Confiado por engenheiros da Amazon, Google, Shopify e Webflow.**
|
|
|
|
[Por que eu criei isso](#por-que-eu-criei-isso) · [Como funciona](#como-funciona) · [Comandos](#comandos) · [Por que funciona](#por-que-funciona) · [Guia do usuário](docs/pt-BR/USER-GUIDE.md)
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## Por que eu criei isso
|
|
|
|
Sou desenvolvedor solo. Eu não escrevo código — o Claude Code escreve.
|
|
|
|
Existem outras ferramentas de desenvolvimento orientado por especificação. BMAD, Speckit... Mas quase todas parecem mais complexas do que o necessário (cerimônias de sprint, story points, sync com stakeholders, retrospectivas, fluxos Jira) ou não entendem de verdade o panorama do que você está construindo. Eu não sou uma empresa de software com 50 pessoas. Não quero teatro corporativo. Só quero construir coisas boas que funcionem.
|
|
|
|
Então eu criei o GSD. A complexidade fica no sistema, não no seu fluxo. Por trás: engenharia de contexto, formatação XML de prompts, orquestração de subagentes, gerenciamento de estado. O que você vê: alguns comandos que simplesmente funcionam.
|
|
|
|
O sistema dá ao Claude tudo que ele precisa para fazer o trabalho *e* validar o resultado. Eu confio no fluxo. Ele entrega.
|
|
|
|
— **TÂCHES**
|
|
|
|
---
|
|
|
|
Vibe coding ganhou má fama. Você descreve algo, a IA gera código, e sai um resultado inconsistente que quebra em escala.
|
|
|
|
O GSD corrige isso. É a camada de engenharia de contexto que torna o Claude Code confiável.
|
|
|
|
---
|
|
|
|
## Para quem é
|
|
|
|
Para quem quer descrever o que precisa e receber isso construído do jeito certo — sem fingir que está rodando uma engenharia de 50 pessoas.
|
|
|
|
Quality gates embutidos capturam problemas reais: detecção de schema drift sinaliza mudanças ORM sem migrations, segurança ancora verificação a modelos de ameaça, e detecção de redução de escopo impede o planner de descartar requisitos silenciosamente.
|
|
|
|
### Destaques v1.32.0
|
|
|
|
- **Gates de consistência STATE.md** — `state validate` detecta divergência entre STATE.md e o filesystem; `state sync` reconstrói a partir do estado real do projeto
|
|
- **Flag `--to N`** — Para a execução autônoma após completar uma fase específica
|
|
- **Research gate** — Bloqueia planejamento quando RESEARCH.md tem perguntas abertas não resolvidas
|
|
- **Filtro de escopo do verificador** — Lacunas abordadas em fases posteriores são marcadas como "adiadas", não como lacunas
|
|
- **Guard de leitura antes de edição** — Hook consultivo previne loops de retry infinitos em runtimes não-Claude
|
|
- **Redução de contexto** — Truncamento de Markdown e ordenação de prompts cache-friendly para menor uso de tokens
|
|
- **4 novos runtimes** — Trae, Kilo, Augment e Cline (12 runtimes no total)
|
|
|
|
---
|
|
|
|
## Primeiros passos
|
|
|
|
```bash
|
|
npx get-shit-done-cc@latest
|
|
```
|
|
|
|
O instalador pede:
|
|
1. **Runtime** — Claude Code, OpenCode, Gemini, Kilo, Codex, Copilot, Cursor, Windsurf, Antigravity, Augment, Trae, Cline, ou todos
|
|
2. **Local** — Global (todos os projetos) ou local (apenas projeto atual)
|
|
|
|
Verifique com:
|
|
- Claude Code / Gemini / Copilot / Antigravity: `/gsd-help`
|
|
- OpenCode / Kilo / Augment / Trae: `/gsd-help`
|
|
- Codex: `$gsd-help`
|
|
- Cline: GSD instala via `.clinerules` — verifique se `.clinerules` existe
|
|
|
|
> [!NOTE]
|
|
> Claude Code 2.1.88+ e Codex instalam como skills (`skills/gsd-*/SKILL.md`). Cline usa `.clinerules`. O instalador lida com todos os formatos automaticamente.
|
|
|
|
> [!TIP]
|
|
> Para instalação a partir do código-fonte ou ambientes sem npm, consulte **[docs/manual-update.md](docs/manual-update.md)**.
|
|
|
|
### Mantendo atualizado
|
|
|
|
```bash
|
|
npx get-shit-done-cc@latest
|
|
```
|
|
|
|
<details>
|
|
<summary><strong>Instalação não interativa (Docker, CI, Scripts)</strong></summary>
|
|
|
|
```bash
|
|
# Claude Code
|
|
npx get-shit-done-cc --claude --global
|
|
npx get-shit-done-cc --claude --local
|
|
|
|
# OpenCode
|
|
npx get-shit-done-cc --opencode --global
|
|
|
|
# Gemini CLI
|
|
npx get-shit-done-cc --gemini --global
|
|
|
|
# Kilo
|
|
npx get-shit-done-cc --kilo --global
|
|
npx get-shit-done-cc --kilo --local
|
|
|
|
# Codex
|
|
npx get-shit-done-cc --codex --global
|
|
npx get-shit-done-cc --codex --local
|
|
|
|
# Copilot
|
|
npx get-shit-done-cc --copilot --global
|
|
npx get-shit-done-cc --copilot --local
|
|
|
|
# Cursor
|
|
npx get-shit-done-cc --cursor --global
|
|
npx get-shit-done-cc --cursor --local
|
|
|
|
# Antigravity
|
|
npx get-shit-done-cc --antigravity --global
|
|
npx get-shit-done-cc --antigravity --local
|
|
|
|
# Augment
|
|
npx get-shit-done-cc --augment --global # Install to ~/.augment/
|
|
npx get-shit-done-cc --augment --local # Install to ./.augment/
|
|
|
|
# Trae
|
|
npx get-shit-done-cc --trae --global # Install to ~/.trae/
|
|
npx get-shit-done-cc --trae --local # Install to ./.trae/
|
|
|
|
# Cline
|
|
npx get-shit-done-cc --cline --global # Install to ~/.cline/
|
|
npx get-shit-done-cc --cline --local # Install to ./.clinerules
|
|
|
|
# Todos
|
|
npx get-shit-done-cc --all --global
|
|
```
|
|
|
|
Use `--global` (`-g`) ou `--local` (`-l`) para pular a pergunta de local.
|
|
Use `--claude`, `--opencode`, `--gemini`, `--kilo`, `--codex`, `--copilot`, `--cursor`, `--windsurf`, `--antigravity`, `--augment`, `--trae`, `--cline` ou `--all` para pular a pergunta de runtime.
|
|
|
|
</details>
|
|
|
|
### Recomendado: modo sem permissões
|
|
|
|
```bash
|
|
claude --dangerously-skip-permissions
|
|
```
|
|
|
|
> [!TIP]
|
|
> Esse é o modo pensado para o GSD: aprovar `date` e `git commit` 50 vezes mata a produtividade.
|
|
|
|
---
|
|
|
|
## Como funciona
|
|
|
|
> **Já tem código?** Rode `/gsd-map-codebase` primeiro para analisar stack, arquitetura, convenções e riscos.
|
|
|
|
### 1. Inicializar projeto
|
|
|
|
```
|
|
/gsd-new-project
|
|
```
|
|
|
|
O sistema:
|
|
1. **Pergunta** até entender seu objetivo
|
|
2. **Pesquisa** o domínio com agentes em paralelo
|
|
3. **Extrai requisitos** (v1, v2 e fora de escopo)
|
|
4. **Monta roadmap** por fases
|
|
|
|
**Cria:** `PROJECT.md`, `REQUIREMENTS.md`, `ROADMAP.md`, `STATE.md`, `.planning/research/`
|
|
|
|
### 2. Discutir fase
|
|
|
|
```
|
|
/gsd-discuss-phase 1
|
|
```
|
|
|
|
Captura suas preferências de implementação antes do planejamento.
|
|
|
|
**Cria:** `{phase_num}-CONTEXT.md`
|
|
|
|
### 3. Planejar fase
|
|
|
|
```
|
|
/gsd-plan-phase 1
|
|
```
|
|
|
|
1. Pesquisa abordagens
|
|
2. Cria 2-3 planos atômicos em XML
|
|
3. Verifica contra os requisitos
|
|
|
|
**Cria:** `{phase_num}-RESEARCH.md`, `{phase_num}-{N}-PLAN.md`
|
|
|
|
### 4. Executar fase
|
|
|
|
```
|
|
/gsd-execute-phase 1
|
|
```
|
|
|
|
1. Executa planos em ondas
|
|
2. Contexto novo por plano
|
|
3. Commit atômico por tarefa
|
|
4. Verifica contra objetivos
|
|
|
|
**Cria:** `{phase_num}-{N}-SUMMARY.md`, `{phase_num}-VERIFICATION.md`
|
|
|
|
### 5. Verificar trabalho
|
|
|
|
```
|
|
/gsd-verify-work 1
|
|
```
|
|
|
|
Validação manual orientada para confirmar que a feature realmente funciona como esperado.
|
|
|
|
**Cria:** `{phase_num}-UAT.md` e planos de correção se necessário
|
|
|
|
### 6. Repetir -> Entregar -> Completar
|
|
|
|
```
|
|
/gsd-discuss-phase 2
|
|
/gsd-plan-phase 2
|
|
/gsd-execute-phase 2
|
|
/gsd-verify-work 2
|
|
/gsd-ship 2
|
|
/gsd-complete-milestone
|
|
/gsd-new-milestone
|
|
```
|
|
|
|
Ou deixe o GSD decidir:
|
|
|
|
```
|
|
/gsd-next
|
|
```
|
|
|
|
### Modo rápido
|
|
|
|
```
|
|
/gsd-quick
|
|
```
|
|
|
|
Para tarefas ad-hoc sem ciclo completo de planejamento.
|
|
|
|
---
|
|
|
|
## Por que funciona
|
|
|
|
### Engenharia de contexto
|
|
|
|
| Arquivo | Papel |
|
|
|---------|-------|
|
|
| `PROJECT.md` | Visão do projeto |
|
|
| `research/` | Conhecimento do ecossistema |
|
|
| `REQUIREMENTS.md` | Escopo v1/v2 |
|
|
| `ROADMAP.md` | Direção e progresso |
|
|
| `STATE.md` | Memória entre sessões |
|
|
| `PLAN.md` | Tarefa atômica com XML |
|
|
| `SUMMARY.md` | O que mudou |
|
|
| `todos/` | Ideias para depois |
|
|
| `threads/` | Contexto persistente |
|
|
| `seeds/` | Ideias para próximos marcos |
|
|
|
|
### Formato XML de prompt
|
|
|
|
```xml
|
|
<task type="auto">
|
|
<name>Create login endpoint</name>
|
|
<files>src/app/api/auth/login/route.ts</files>
|
|
<action>
|
|
Use jose for JWT (not jsonwebtoken - CommonJS issues).
|
|
Validate credentials against users table.
|
|
Return httpOnly cookie on success.
|
|
</action>
|
|
<verify>curl -X POST localhost:3000/api/auth/login returns 200 + Set-Cookie</verify>
|
|
<done>Valid credentials return cookie, invalid return 401</done>
|
|
</task>
|
|
```
|
|
|
|
### Orquestração multiagente
|
|
|
|
Um orquestrador leve chama agentes especializados para pesquisa, planejamento, execução e verificação.
|
|
|
|
### Commits atômicos
|
|
|
|
Cada tarefa gera commit próprio, facilitando `git bisect`, rollback e rastreabilidade.
|
|
|
|
---
|
|
|
|
## Comandos
|
|
|
|
### Fluxo principal
|
|
|
|
| Comando | O que faz |
|
|
|---------|-----------|
|
|
| `/gsd-new-project [--auto]` | Inicializa projeto completo |
|
|
| `/gsd-discuss-phase [N] [--auto] [--analyze] [--chain]` | Captura decisões antes do plano (`--chain` encadeia automaticamente em plan+execute) |
|
|
| `/gsd-plan-phase [N] [--auto] [--reviews]` | Pesquisa + plano + validação |
|
|
| `/gsd-execute-phase <N>` | Executa planos em ondas paralelas |
|
|
| `/gsd-verify-work [N]` | UAT manual |
|
|
| `/gsd-ship [N] [--draft]` | Cria PR da fase validada |
|
|
| `/gsd-next` | Avança automaticamente para o próximo passo |
|
|
| `/gsd-fast <text>` | Tarefas triviais sem planejamento |
|
|
| `/gsd-complete-milestone` | Fecha o marco e marca release |
|
|
| `/gsd-new-milestone [name]` | Inicia próximo marco |
|
|
|
|
### Qualidade e utilidades
|
|
|
|
| Comando | O que faz |
|
|
|---------|-----------|
|
|
| `/gsd-review` | Peer review com múltiplas IAs |
|
|
| `/gsd-pr-branch` | Cria branch limpa para PR |
|
|
| `/gsd-settings` | Configura perfis e agentes |
|
|
| `/gsd-set-profile <profile>` | Troca perfil (quality/balanced/budget/inherit) |
|
|
| `/gsd-quick [--full] [--discuss] [--research]` | Execução rápida com garantias do GSD (`--full` ativa todas as etapas, `--validate` ativa apenas verificação) |
|
|
| `/gsd-health [--repair]` | Verifica e repara `.planning/` |
|
|
|
|
> Para a lista completa de comandos e opções, use `/gsd-help`.
|
|
|
|
---
|
|
|
|
## Configuração
|
|
|
|
As configurações do projeto ficam em `.planning/config.json`.
|
|
Você pode configurar no `/gsd-new-project` ou ajustar depois com `/gsd-settings`.
|
|
|
|
### Ajustes principais
|
|
|
|
| Configuração | Opções | Padrão | Controle |
|
|
|--------------|--------|--------|----------|
|
|
| `mode` | `yolo`, `interactive` | `interactive` | Autoaprovar vs confirmar etapas |
|
|
| `granularity` | `coarse`, `standard`, `fine` | `standard` | Granularidade de fases/planos |
|
|
|
|
### Perfis de modelo
|
|
|
|
| Perfil | Planejamento | Execução | Verificação |
|
|
|--------|--------------|----------|-------------|
|
|
| `quality` | Opus | Opus | Sonnet |
|
|
| `balanced` | Opus | Sonnet | Sonnet |
|
|
| `budget` | Sonnet | Sonnet | Haiku |
|
|
| `inherit` | Inherit | Inherit | Inherit |
|
|
|
|
Troca rápida:
|
|
```
|
|
/gsd-set-profile budget
|
|
```
|
|
|
|
---
|
|
|
|
## Segurança
|
|
|
|
### Endurecimento embutido
|
|
|
|
O GSD inclui proteções como:
|
|
- prevenção de path traversal
|
|
- detecção de prompt injection
|
|
- validação de argumentos de shell
|
|
- parsing seguro de JSON
|
|
- scanner de injeção para CI
|
|
|
|
### Protegendo arquivos sensíveis
|
|
|
|
Adicione padrões sensíveis ao deny list do Claude Code:
|
|
|
|
```json
|
|
{
|
|
"permissions": {
|
|
"deny": [
|
|
"Read(.env)",
|
|
"Read(.env.*)",
|
|
"Read(**/secrets/*)",
|
|
"Read(**/*credential*)",
|
|
"Read(**/*.pem)",
|
|
"Read(**/*.key)"
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Solução de problemas
|
|
|
|
**Comandos não apareceram após instalar?**
|
|
- Reinicie o runtime
|
|
- Verifique se os arquivos foram instalados no diretório correto
|
|
|
|
**Comandos não funcionam como esperado?**
|
|
- Rode `/gsd-help`
|
|
- Reinstale com `npx get-shit-done-cc@latest`
|
|
|
|
**Em Docker/container?**
|
|
- Defina `CLAUDE_CONFIG_DIR` antes da instalação:
|
|
|
|
```bash
|
|
CLAUDE_CONFIG_DIR=/home/youruser/.claude npx get-shit-done-cc --global
|
|
```
|
|
|
|
### Desinstalar
|
|
|
|
```bash
|
|
# Instalações globais
|
|
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 --kilo --global --uninstall
|
|
npx get-shit-done-cc --codex --global --uninstall
|
|
npx get-shit-done-cc --copilot --global --uninstall
|
|
npx get-shit-done-cc --cursor --global --uninstall
|
|
npx get-shit-done-cc --antigravity --global --uninstall
|
|
npx get-shit-done-cc --augment --global --uninstall
|
|
npx get-shit-done-cc --trae --global --uninstall
|
|
npx get-shit-done-cc --cline --global --uninstall
|
|
|
|
# Instalações locais (projeto atual)
|
|
npx get-shit-done-cc --claude --local --uninstall
|
|
npx get-shit-done-cc --opencode --local --uninstall
|
|
npx get-shit-done-cc --gemini --local --uninstall
|
|
npx get-shit-done-cc --kilo --local --uninstall
|
|
npx get-shit-done-cc --codex --local --uninstall
|
|
npx get-shit-done-cc --copilot --local --uninstall
|
|
npx get-shit-done-cc --cursor --local --uninstall
|
|
npx get-shit-done-cc --antigravity --local --uninstall
|
|
npx get-shit-done-cc --augment --local --uninstall
|
|
npx get-shit-done-cc --trae --local --uninstall
|
|
npx get-shit-done-cc --cline --local --uninstall
|
|
```
|
|
|
|
---
|
|
|
|
## Community Ports
|
|
|
|
OpenCode, Gemini CLI, Kilo e Codex agora são suportados nativamente via `npx get-shit-done-cc`.
|
|
|
|
| Projeto | Plataforma | Descrição |
|
|
|---------|------------|-----------|
|
|
| [gsd-opencode](https://github.com/rokicool/gsd-opencode) | OpenCode | Adaptação original para OpenCode |
|
|
| gsd-gemini (archived) | Gemini CLI | Adaptação original para Gemini por uberfuzzy |
|
|
|
|
---
|
|
|
|
## Star History
|
|
|
|
<a href="https://star-history.com/#gsd-build/get-shit-done&Date">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=gsd-build/get-shit-done&type=Date&theme=dark" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=gsd-build/get-shit-done&type=Date" />
|
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=gsd-build/get-shit-done&type=Date" />
|
|
</picture>
|
|
</a>
|
|
|
|
---
|
|
|
|
## Licença
|
|
|
|
Licença MIT. Veja [LICENSE](LICENSE).
|
|
|
|
---
|
|
|
|
<div align="center">
|
|
|
|
**Claude Code é poderoso. O GSD o torna confiável.**
|
|
|
|
</div>
|