GitScrum / Docs

Configuração

Configure GitScrum CLI com config global e .gitscrum.yml por projeto. Variáveis de ambiente, ajustes de timer e formato de branches.

O CLI usa um sistema de configuração em camadas: global, projeto e variáveis de ambiente.


Hierarquia de Configuração

Prioridade (da maior para menor):

  1. Variáveis de AmbienteGITSCRUM_*
  2. Configuração de Projeto.gitscrum.yml
  3. Configuração Global~/.gitscrum/config.yml
  4. Valores Padrão

Configuração Global

Localização: ~/.gitscrum/config.yml

Usando Comandos

gitscrum config set default_project meu-projeto
gitscrum config set timer.auto_start true
gitscrum config get default_project
gitscrum config list

Arquivo de Configuração

# ~/.gitscrum/config.yml
default_project: meu-projeto
output_format: text

timer:
  auto_start: false
  idle_timeout: 15m

git:
  branch_format: "{type}/{id}-{slug}"

aliases:
  dash: acme-dashboard

Configuração de Projeto

# .gitscrum.yml
project: meu-projeto

timer:
  auto_start: true
  idle_timeout: 15m
  round_to: 5m

git:
  branch_format: "{type}/{id}-{slug}"
  default_type: feature

hooks:
  commit_msg:
    enabled: true
    format: "[{id}] "

Variáveis de Ambiente

VariávelDescrição
GITSCRUMACCESSTOKENToken OAuth (para CI/CD)
GITSCRUM_PROJECTSobrescrever projeto
GITSCRUM_BRANCHSobrescrever branch
GITSCRUM_DEBUGHabilitar debug
export GITSCRUM_ACCESS_TOKEN="seu-token"
gitscrum task list

Referência de Timer

ChaveTipoPadrãoDescrição
timer.auto_startboolfalseIniciar ao trocar branch
timer.auto_stopbooltruePausar em inatividade
timer.idle_timeoutduration15mTempo de inatividade
timer.round_toduration1mArredondamento

Formato de Branch

git:
  branch_format: "{type}/{id}-{slug}"

Placeholders: {id}, {type}, {slug}, {user}


Validar Configuração

gitscrum config validate