GitScrum / Docs

Vue d'ensemble

Gérez tâches, sprints et temps depuis votre terminal. GitScrum CLI est open source, binaire unique Go, sans dépendances.

⚠️ BETA — GitScrum CLI est en développement actif. Open source sous licence MIT. Disponible sur GitHub.

Un seul binaire. Aucune dépendance. Gestion de projets là où vous travaillez vraiment—votre terminal.

Pourquoi CLI ?

Votre navigateur a 47 onglets. Slack demande de l'attention. GitScrum CLI vous maintient dans le flow :

# Voir votre tâche actuelle (détectée depuis la branche Git)
gitscrum tasks current

# Démarrer le timer, continuer à coder
gitscrum timer start

# Marquer comme terminée
gitscrum tasks complete a1b2c3d4

Sans changement de contexte. Sans navigateur. Sans friction.

Installation

macOS/Linux :

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

Windows :

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

Autres options :

# 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

Vérifiez l'installation :

gitscrum --version

Démarrage Rapide

1. Authentification

gitscrum login

Un navigateur s'ouvre. Vous vous connectez. Retour au terminal. Terminé.

2. Liez votre Projet

cd mon-projet
gitscrum init

Sélectionnez votre projet GitScrum. Crée .gitscrum.yml avec la configuration.

3. Commencez à Travailler

# Lister vos tâches
gitscrum tasks

# Voir les détails d'une tâche
gitscrum tasks view a1b2c3d4

# Démarrer le timer
gitscrum timer start a1b2c3d4

# Arrêter le timer
gitscrum timer stop

Commandes Principales

Tâches

gitscrum tasks                        # Lister vos tâches
gitscrum tasks view a1b2c3d4          # Voir détails
gitscrum tasks current                # Tâche actuelle (depuis branche Git)
gitscrum tasks create -t "Titre"      # Créer tâche
gitscrum tasks complete a1b2c3d4      # Marquer comme terminée
gitscrum tasks branch a1b2c3d4        # Créer branche depuis tâche
gitscrum tasks comment a1b2c3d4       # Voir/ajouter commentaires

Timer

gitscrum timer                        # Voir timer actif
gitscrum timer start a1b2c3d4         # Démarrer timer pour tâche
gitscrum timer stop                   # Arrêter et enregistrer
gitscrum timer log                    # Enregistrer temps manuel
gitscrum timer report                 # Rapport de temps

Sprints

gitscrum sprints                      # Lister sprints
gitscrum sprints current              # Sprint actuel avec KPIs
gitscrum sprints view [slug]          # Détails du sprint
gitscrum sprints burndown             # Graphique burndown ASCII

Standups

gitscrum standup                      # Résumé du standup quotidien
gitscrum standup team                 # Standups de l'équipe
gitscrum standup blockers             # Lister les blocages

Analytics

gitscrum analytics velocity           # Tendance de vélocité
gitscrum analytics blockers           # Tâches bloquées
gitscrum analytics workload           # Distribution de l'équipe

Wiki et Communication

gitscrum wiki                         # Lister pages wiki
gitscrum wiki view [slug]             # Voir page wiki
gitscrum chat                         # Discussions d'équipe
gitscrum notifications                # Voir notifications

Configuration

gitscrum login                        # Authentifier via OAuth
gitscrum logout                       # Déconnecter
gitscrum status                       # Voir statut actuel
gitscrum config set workspace [slug]  # Définir workspace par défaut
gitscrum workspaces                   # Lister workspaces
gitscrum projects                     # Lister projets

Détection Git

Le CLI est conscient de Git. Détecte automatiquement :

  • Dépôt actuel → lié au bon projet
  • Nom de branche → extrait le code de tâche (ex., feature/GS-123-auth)
  • Contexte worktree → fonctionne avec git worktrees
$ git checkout feature/GS-123-refactor-auth

$ gitscrum tasks current
📋 GS-123: Refactoriser module d'authentification
   Statut: En Cours | Sprint 15

Modes de Sortie

gitscrum tasks              # Table (par défaut)
gitscrum tasks --json       # JSON pour scripts
gitscrum tasks -q           # Mode silencieux (IDs seulement)

Parfait pour pipelines CI/CD, intégrations et scripts.

CI/CD

Le CLI fonctionne en pipelines headless :

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

Open Source

Licence MIT. Contribuez sur GitHub :

github.com/gitscrum-core/cli

Prochaines Étapes