Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Git Town configuration file

Git Town can be configured through a configuration file named git-town.toml, .git-town.toml, or .git-branches.toml. To create one, run:

git town init

Here is an example configuration file with the default settings:

[branches]
main = "" # must be set by the user
contribution-regex = ""
default-type = "feature"
feature-regex = ""
observed-regex = ""
perennial-regex = ""
perennials = []

[create]
branch-prefix = ""
new-branch-type = "feature"
share-new-branches = "no"

[hosting]
dev-remote = "origin"
origin-hostname = "" # use the hostname in the origin URL
forge-type = "" # auto-detect

[propose]
breadcrumb = "none"
breadcrumb-direction = "down"

[ship]
delete-tracking-branch = true
strategy = "api"

[sync]
auto-sync = true
feature-strategy = "merge"
perennial-strategy = "rebase"
prototype-strategy = "rebase"
push-hook = true
tags = true
upstream = true