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):
- Variáveis de Ambiente —
GITSCRUM_* - Configuração de Projeto —
.gitscrum.yml - Configuração Global —
~/.gitscrum/config.yml - 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 listArquivo 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-dashboardConfiguraçã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ável | Descrição |
|---|---|
GITSCRUMACCESSTOKEN | Token OAuth (para CI/CD) |
GITSCRUM_PROJECT | Sobrescrever projeto |
GITSCRUM_BRANCH | Sobrescrever branch |
GITSCRUM_DEBUG | Habilitar debug |
export GITSCRUM_ACCESS_TOKEN="seu-token"
gitscrum task listReferência de Timer
| Chave | Tipo | Padrão | Descrição |
|---|---|---|---|
timer.auto_start | bool | false | Iniciar ao trocar branch |
timer.auto_stop | bool | true | Pausar em inatividade |
timer.idle_timeout | duration | 15m | Tempo de inatividade |
timer.round_to | duration | 1m | Arredondamento |
Formato de Branch
git:
branch_format: "{type}/{id}-{slug}"Placeholders: {id}, {type}, {slug}, {user}
Validar Configuração
gitscrum config validate