GitScrum / Docs

Démarrage Rapide

Installez GitScrum CLI sur macOS, Linux ou Windows. Authentifiez-vous, liez votre projet et gérez vos tâches depuis le terminal.

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

De zéro à productif en 2 minutes.


Installation

macOS et Linux

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

Windows

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

Ou avec Scoop :

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

Homebrew (macOS)

brew install gitscrum-core/tap/gitscrum

Vérifier l'Installation

gitscrum --version

Authentification

gitscrum login
Ouverture du navigateur pour authentification...
✓ Authentifié en tant que john.dev
✓ Token stocké dans ~/.gitscrum/token.json

Vérifiez l'authentification :

gitscrum status
Connecté en tant que John Doe (john@entreprise.com)
Workspace: mon-entreprise
Projet: backend-api

Configuration du Projet

cd mon-projet
gitscrum init
? Sélectionnez le projet GitScrum :
  ❯ mon-projet

✓ Projet lié : mon-projet
✓ Créé .gitscrum.yml

Conseil : Committez .gitscrum.yml pour que votre équipe ait la même configuration.


Premier Workflow

1. Voir Vos Tâches

gitscrum tasks
CODE      TITLE                              STATUS         EFFORT
GS-1234   Refactoriser module auth           En Cours       8 pts
GS-1235   Ajouter tests OAuth                À FAIRE        3 pts
GS-1236   Mettre à jour docs API             En Révision    2 pts

2. Créer une Branche

gitscrum tasks branch a1b2c3d4
✓ Créée branche: feature/GS-1234-refactoriser-module-auth
✓ Basculé vers la branche

3. Voir Tâche Actuelle

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

4. Démarrer le Timer

gitscrum timer start

5. Arrêter et Enregistrer

gitscrum timer stop

6. Marquer comme Terminée

gitscrum tasks complete a1b2c3d4
✓ GS-1234 marquée comme terminée

Commandes Essentielles

# Tâches
gitscrum tasks                    # Lister vos tâches
gitscrum tasks current            # Tâche actuelle (depuis branche Git)
gitscrum tasks view a1b2c3d4      # Détails de la tâche

# Timer
gitscrum timer start              # Démarrer timer
gitscrum timer stop               # Arrêter et enregistrer
gitscrum timer                    # Voir timer actuel

# Sprint
gitscrum sprints current          # Détails du sprint actuel

# Aide
gitscrum --help                   # Voir toutes les commandes
gitscrum tasks --help             # Aide spécifique de la commande

Raccourcis Shell

Ajoutez à votre .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"

Prochaines Étapes

  • Configuration — Personnalisez avec .gitscrum.yml
  • Tâches — Commandes de tâches en détail
  • Timer — Suivi du temps avancé