GitScrum / Docs

Início Rápido

Instale GitScrum CLI no macOS, Linux ou Windows. Autentique, vincule seu projeto e comece a gerenciar tarefas do terminal.

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

Do zero ao produtivo em 2 minutos. Vamos instalar o CLI e vinculá-lo ao seu projeto GitScrum.


Instalação

macOS e Linux

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

Windows

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

Ou usando Scoop:

scoop bucket add gitscrum https://github.com/gitscrum-core/scoop-bucket
scoop install gitscrum

Homebrew (macOS)

brew install gitscrum-core/tap/gitscrum

Verificar Instalação

gitscrum --version

Autenticação

Vincule o CLI à sua conta GitScrum:

gitscrum login
Abrindo navegador para autenticação...
Se o navegador não abrir, visite: https://gitscrum.com/cli/auth?code=ABCD-1234

Aguardando autorização...
✓ Autenticado como john.dev
✓ Token armazenado em ~/.gitscrum/token.json

Verifique a autenticação:

gitscrum status
Logado como John Doe (john@empresa.com)
Workspace: minha-empresa
Projeto: backend-api

Configuração do Projeto

Navegue até seu repositório e vincule o projeto:

cd meu-projeto
gitscrum init
? Selecione projeto GitScrum:
  ❯ meu-projeto
    outro-projeto

✓ Projeto vinculado: meu-projeto
✓ Criado .gitscrum.yml

Dica: Faça commit do .gitscrum.yml para que sua equipe tenha a mesma configuração.


Seu Primeiro Workflow

1. Ver Suas Tarefas

gitscrum tasks

2. Criar Branch de Trabalho

gitscrum tasks branch a1b2c3d4

3. Ver Tarefa Atual

gitscrum tasks current

4. Iniciar Timer

gitscrum timer start a1b2c3d4

5. Parar e Registrar Tempo

gitscrum timer stop

6. Marcar Tarefa como Concluída

gitscrum tasks complete a1b2c3d4

Comandos Essenciais

gitscrum tasks                    # Listar suas tarefas
gitscrum tasks current            # Tarefa atual (da branch Git)
gitscrum timer start              # Iniciar timer
gitscrum timer stop               # Parar e registrar
gitscrum sprints current          # Detalhes do sprint atual
gitscrum --help                   # Ver todos os comandos

Atalhos de Shell

Adicione ao seu .bashrc ou .zshrc:

alias gs="gitscrum"
alias gst="gitscrum tasks"
alias gstl="gitscrum tasks"
alias gstc="gitscrum tasks current"
alias gsti="gitscrum timer start"
alias gsto="gitscrum timer stop"

Próximos Passos