GitScrum / Docs

Inicio Rápido

Instala GitScrum CLI en macOS, Linux o Windows. Autentícate, vincula tu proyecto y empieza a gestionar tareas desde el terminal.

⚠️ BETA — GitScrum CLI está en desarrollo activo. Open source bajo licencia MIT. Disponible en GitHub.

Del zero al productivo en 2 minutos. Instalemos el CLI y vinculémoslo a tu proyecto GitScrum.

Instalación

macOS y Linux

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

¿Qué hace esto?

  • Detecta tu SO y arquitectura
  • Descarga el binario correcto
  • Lo instala en /usr/local/bin
  • Verifica la suma de comprobación

Windows

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

O usando Scoop:

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

Homebrew (macOS)

brew install gitscrum-core/tap/gitscrum

Go Install

Si tienes Go 1.21+:

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

Verificar Instalación

gitscrum --version
# gitscrum version 1.0.0 (abc1234)

Autenticación

Vincula el CLI a tu cuenta de GitScrum:

gitscrum login

Resultado:

Abriendo navegador para autenticación...
Si el navegador no abre, visita: https://gitscrum.com/cli/auth?code=ABCD-1234

Esperando autorización...
✓ Autenticado como john.dev
✓ Token almacenado en ~/.gitscrum/token.json

Verifica la autenticación:

gitscrum status
Logueado como John Doe (john@empresa.com)
Workspace: mi-empresa
Proyecto: backend-api

¿Qué Sucede?

  1. El CLI genera un código de dispositivo
  2. Te autenticas en tu navegador (puedes usar 2FA, SSO, etc.)
  3. El CLI recibe un token OAuth
  4. El token se almacena localmente

Esto usa OAuth 2.0 Device Flow—seguro, sin contraseñas en el terminal.

Configuración del Proyecto

Navega a tu repositorio y vincula el proyecto:

cd mi-proyecto
gitscrum init

Selección interactiva:

? Selecciona proyecto de GitScrum:
  ❯ mi-proyecto
    otro-proyecto
    proyecto-demo

✓ Proyecto vinculado: mi-proyecto
✓ Creado .gitscrum.yml

Tip: Haz commit de .gitscrum.yml para que tu equipo tenga la misma configuración.

Tu Primer Flujo de Trabajo

1. Ver Tus Tareas

gitscrum tasks
CODE      TITLE                              STATUS         EFFORT
GS-1234   Refactorizar módulo auth           En Progreso    8 pts
GS-1235   Agregar tests OAuth                TODO           3 pts
GS-1236   Actualizar documentos API          En Revisión    2 pts

2. Crear Rama de Trabajo

gitscrum tasks branch a1b2c3d4
✓ Creada rama: feature/GS-1234-refactorizar-modulo-auth
✓ Cambiado a la rama

3. Ver Tarea Actual

El CLI detecta tu tarea desde el nombre de la rama:

gitscrum tasks current
📋 GS-1234: Refactorizar módulo de autenticación
   Estado: En Progreso | Sprint 15

4. Iniciar Timer

gitscrum timer start
⏱️  Timer iniciado para GS-1234: Refactorizar módulo auth
    Desde: 09:15 AM

5. Parar y Registrar Tiempo

gitscrum timer stop
⏱️  Timer detenido

Tarea:     GS-1234 - Refactorizar módulo auth
Duración:  2h 34m
Total hoy: 4h 49m

✓ Tiempo registrado

6. Marcar Tarea como Completada

gitscrum tasks complete a1b2c3d4
✓ GS-1234 marcada como completada

Comandos Esenciales

# Tareas
gitscrum tasks                    # Listar tus tareas
gitscrum tasks current            # Tarea actual (desde rama Git)
gitscrum tasks view a1b2c3d4      # Detalles de la tarea

# Timer
gitscrum timer start              # Iniciar timer
gitscrum timer stop               # Parar y registrar
gitscrum timer                    # Ver timer actual

# Sprint
gitscrum sprints current          # Detalles del sprint actual

# Ayuda
gitscrum --help                   # Ver todos los comandos
gitscrum tasks --help             # Ayuda específica del comando

Atajos de Shell

Agrega a tu .bashrc o .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"

Ahora:

gstl        # lista tareas
gsti        # inicia timer
gsto        # para timer

Próximos Pasos