GitScrum / Docs

Visão Geral

Gerencie tarefas, sprints e tempo do seu terminal. GitScrum CLI é open source, binário único em Go, sem dependências.

⚠️ BETA — GitScrum CLI está em desenvolvimento ativo. Open source sob licença MIT. Disponível no GitHub.

Um binário. Sem dependências. Gestão de projetos onde você realmente trabalha—seu terminal.

Por Que CLI?

Seu navegador tem 47 abas. Slack pedindo atenção. GitScrum CLI mantém você no fluxo:

# Veja sua tarefa atual (detectada da branch Git)
gitscrum tasks current

# Inicie o timer, continue codando
gitscrum timer start

# Marque como concluída
gitscrum tasks complete a1b2c3d4

Sem troca de contexto. Sem navegador. Sem fricção.

Instalação

macOS/Linux:

curl -fsSL https://cli.gitscrum.com/install.sh | sh

Windows:

irm https://cli.gitscrum.com/install.ps1 | iex

Outras opções:

# Homebrew (macOS)
brew install gitscrum-core/tap/gitscrum

# Scoop (Windows)
scoop bucket add gitscrum https://github.com/gitscrum-core/scoop-bucket
scoop install gitscrum

# Go install
go install github.com/gitscrum-core/cli/cmd/gitscrum@latest

Verifique a instalação:

gitscrum --version

Início Rápido

1. Autenticação

gitscrum login

Um navegador abre. Você faz login. Volta ao terminal. Pronto.

2. Vincule seu Projeto

cd meu-projeto
gitscrum init

Selecione seu projeto GitScrum. Cria .gitscrum.yml com a configuração.

3. Comece a Trabalhar

# Liste suas tarefas
gitscrum tasks

# Veja detalhes de uma tarefa
gitscrum tasks view a1b2c3d4

# Inicie o timer
gitscrum timer start a1b2c3d4

# Pare o timer
gitscrum timer stop

Comandos Principais

Tarefas

gitscrum tasks                        # Listar suas tarefas
gitscrum tasks view a1b2c3d4          # Ver detalhes da tarefa
gitscrum tasks current                # Tarefa atual (da branch Git)
gitscrum tasks create -t "Título"     # Criar nova tarefa
gitscrum tasks complete a1b2c3d4      # Marcar como concluída
gitscrum tasks branch a1b2c3d4        # Criar branch da tarefa
gitscrum tasks comment a1b2c3d4       # Ver/adicionar comentários

Timer

gitscrum timer                        # Ver timer ativo
gitscrum timer start a1b2c3d4         # Iniciar timer para tarefa
gitscrum timer stop                   # Parar e registrar
gitscrum timer log                    # Registrar tempo manual
gitscrum timer report                 # Relatório de tempo

Sprints

gitscrum sprints                      # Listar sprints
gitscrum sprints current              # Sprint atual com KPIs
gitscrum sprints view [slug]          # Detalhes do sprint
gitscrum sprints burndown             # Gráfico burndown ASCII

Standups

gitscrum standup                      # Resumo do standup diário
gitscrum standup team                 # Standups da equipe
gitscrum standup blockers             # Listar bloqueios

Analytics

gitscrum analytics velocity           # Tendência de velocidade
gitscrum analytics blockers           # Tarefas bloqueadas
gitscrum analytics workload           # Distribuição da equipe

Wiki e Comunicação

gitscrum wiki                         # Listar páginas wiki
gitscrum wiki view [slug]             # Ver página wiki
gitscrum chat                         # Discussões do time
gitscrum notifications                # Ver notificações

Configuração

gitscrum login                        # Autenticar via OAuth
gitscrum logout                       # Sair
gitscrum status                       # Ver status atual
gitscrum config set workspace [slug]  # Definir workspace padrão
gitscrum workspaces                   # Listar workspaces
gitscrum projects                     # Listar projetos

Detecção de Git

O CLI é consciente do Git. Detecta automaticamente:

  • Repositório atual → vinculado ao projeto correto
  • Nome da branch → extrai código da tarefa (ex., feature/GS-123-auth)
  • Contexto do worktree → funciona com git worktrees
$ git checkout feature/GS-123-refactor-auth

$ gitscrum tasks current
📋 GS-123: Refatorar módulo de autenticação
   Status: Em Progresso | Sprint 15

Código Aberto

Licença MIT. Contribua no GitHub:

github.com/gitscrum-core/cli

Próximos Passos