GitScrum / Docs

Descripción General

Gestiona tareas, sprints y tiempo desde tu terminal. GitScrum CLI es una herramienta de código abierto con un solo binario Go, sin dependencias.

⚠️ BETA — GitScrum CLI está en desarrollo activo. Código abierto bajo licencia MIT. Disponible en GitHub.

Un solo binario. Sin dependencias. Gestión de proyectos desde donde realmente trabajas—tu terminal.


¿Por Qué CLI?

Tu navegador tiene 47 pestañas. Slack pide atención. GitScrum CLI te mantiene en flujo:

# Ve tu tarea actual (detectada desde la rama Git)
gitscrum tasks current

# Inicia el timer, continúa codificando
gitscrum timer start

# Marca como completada
gitscrum tasks complete a1b2c3d4

Sin cambio de contexto. Sin navegador. Sin fricción.


Instalación

macOS/Linux:

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

Windows:

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

Otras opciones:

# 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

Verifica la instalación:

gitscrum --version

Inicio Rápido

1. Autenticación

gitscrum login

Se abre un navegador. Inicias sesión. Vuelves al terminal. Hecho.

2. Vincula tu Proyecto

cd mi-proyecto
gitscrum init

Selecciona tu proyecto de GitScrum. Crea .gitscrum.yml con la configuración.

3. Empieza a Trabajar

# Lista tus tareas
gitscrum tasks

# Ve detalles de una tarea
gitscrum tasks view a1b2c3d4

# Inicia el timer
gitscrum timer start a1b2c3d4

# Para el timer
gitscrum timer stop

Comandos Principales

Tareas

gitscrum tasks                        # Lista tus tareas
gitscrum tasks view a1b2c3d4          # Ver detalles de la tarea
gitscrum tasks current                # Tarea actual (desde rama Git)
gitscrum tasks create -t "Título"     # Crear nueva tarea
gitscrum tasks complete a1b2c3d4      # Marcar como completada
gitscrum tasks branch a1b2c3d4        # Crear rama desde tarea
gitscrum tasks comment a1b2c3d4       # Ver/añadir comentarios

Timer

gitscrum timer                        # Ver timer activo
gitscrum timer start a1b2c3d4         # Iniciar timer para tarea
gitscrum timer stop                   # Parar y registrar
gitscrum timer log                    # Registrar tiempo manual
gitscrum timer report                 # Reporte de tiempo

Sprints

gitscrum sprints                      # Lista sprints
gitscrum sprints current              # Sprint actual con KPIs
gitscrum sprints view [slug]          # Detalles del sprint
gitscrum sprints burndown             # Gráfico burndown ASCII

Standups

gitscrum standup                      # Resumen del standup diario
gitscrum standup team                 # Standups del equipo
gitscrum standup blockers             # Listar bloqueos

Analíticas

gitscrum analytics velocity           # Tendencia de velocidad
gitscrum analytics blockers           # Tareas bloqueadas
gitscrum analytics workload           # Distribución del equipo

Wiki y Comunicación

gitscrum wiki                         # Listar páginas wiki
gitscrum wiki view [slug]             # Ver página wiki
gitscrum chat                         # Discusiones del equipo
gitscrum notifications                # Ver notificaciones

Configuración

gitscrum login                        # Autenticar via OAuth
gitscrum logout                       # Cerrar sesión
gitscrum status                       # Ver estado actual
gitscrum config set workspace [slug]  # Definir workspace por defecto
gitscrum workspaces                   # Listar workspaces
gitscrum projects                     # Listar proyectos

Detección de Git

El CLI es consciente de Git. Detecta automáticamente:

  • Repositorio actual → vinculado al proyecto correcto
  • Nombre de la rama → extrae código de tarea (ej., feature/GS-123-auth)
  • Contexto del worktree → funciona con git worktrees
$ git checkout feature/GS-123-refactor-auth

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

Modos de Salida

gitscrum tasks              # Tabla (predeterminado)
gitscrum tasks --json       # JSON para scripts
gitscrum tasks -q           # Modo silencioso (solo IDs)

Perfecto para pipelines CI/CD, integraciones y scripts.


CI/CD

El CLI funciona en pipelines headless:

# .github/workflows/deploy.yml
- name: Completar tarea
  run: |
    TASK=$(echo "${{ github.head_ref }}" | grep -oE '[A-Z]+-[0-9]+')
    gitscrum tasks complete $TASK
  env:
    GITSCRUM_ACCESS_TOKEN: ${{ secrets.GITSCRUM_ACCESS_TOKEN }}

Código Abierto

MIT License. Contribuye en GitHub:

github.com/gitscrum-core/cli


Próximos Pasos