Git Town

https://www.git-town.com/
Admin
Git Town is a command-line tool that extends Git with reusable workflows for managing branches,...
Tokens:56,871
Snippets:1,106
Trust Score:8.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Git Town using install script

Source: https://www.git-town.com/install

Download and execute the install script for Git Town.

```bash
curl https://www.git-town.com/install.sh | sh
```

--------------------------------

### Git Town Init Command Usage

Source: https://www.git-town.com/commands/init

This snippet shows the basic usage of the git town init command, including its help and verbose flags. Use this command to start the Git Town setup assistant.

```bash
git town init [-h | --help] [-v | --verbose]
```

--------------------------------

### Initialize Git Town Configuration

Source: https://www.git-town.com/configuration

Run this command to start an interactive configuration process for Git Town. It guides you through all options, explains them, and validates settings.

```bash
git town init
```

--------------------------------

### Example: Running 'make lint' on a Stack

Source: https://www.git-town.com/commands/walk

This example demonstrates how 'git town walk --stack make lint' would execute the 'make lint' command on each branch within the current stack, showing output for each branch.

```bash
git town walk --stack make lint
```

--------------------------------

### Install Git Town on openSUSE 15.x and 16.x

Source: https://www.git-town.com/install

Add the Git Town repository and install the package on openSUSE 15.x and 16.x.

```bash
# replace 15.6 with 16.0 in the following command
zypper ar -f -r https://download.opensuse.org/repositories/home:/ojkastl_buildservice:/git-town/15.6/home:ojkastl_buildservice:git-town.repo
zypper refresh # accept the GPG key for the devel:tools:scm repository
zypper install git-town
```

--------------------------------

### Prepend Command Example: Repository State Before

Source: https://www.git-town.com/commands/prepend

Illustrates the repository's branch stack before running the prepend command.

```text
main
 \
* feature-2
```

--------------------------------

### Park Specific Branches

Source: https://www.git-town.com/commands/park

This example demonstrates how to park multiple specified branches, such as 'alpha' and 'beta'.

```bash
git town park alpha beta
```

--------------------------------

### Install Git Town on RedHat-based Linux

Source: https://www.git-town.com/install

Download and install the .rpm package for RedHat-based Linux systems.

```bash
rpm -i git-town_linux_intel_64.rpm
```

--------------------------------

### Observe Specific Branches

Source: https://www.git-town.com/commands/observe

This example shows how to observe multiple specified branches, such as 'alpha' and 'beta'.

```bash
git town observe alpha beta
```

--------------------------------

### Install Git Town on openSUSE Tumbleweed

Source: https://www.git-town.com/install

Install the git-town package from official repositories on openSUSE Tumbleweed.

```bash
sudo zypper in git-town
```

--------------------------------

### Install Git Town on Windows via Scoop

Source: https://www.git-town.com/print

Install Git Town on Windows using the Scoop package manager. Ensure Scoop is installed and configured.

```powershell
scoop install git-town
```

--------------------------------

### Example Branch Stack

Source: https://www.git-town.com/commands/down

Illustrates a sample branch stack before and after executing the 'git town down' command.

```bash
main
 \
* branch-1
   \
    branch-2
```

```bash
main
 \
  branch-1
   \
*   branch-2
```

--------------------------------

### Swap Command Example: Before

Source: https://www.git-town.com/commands/swap

Illustrates the branch stack structure before executing the 'git town swap' command on 'branch-2'.

```bash
main
 \
  branch-1
   \
*   branch-2
     \
      branch-3
```

--------------------------------

### Install Git Town on Arch Linux

Source: https://www.git-town.com/install

Install the git-town package from official repositories on Arch Linux.

```bash
pacman -S git-town
```

--------------------------------

### Example: Appending with Prototype

Source: https://www.git-town.com/print

Illustrates creating a prototype branch using the --prototype flag.

```bash
git town append <branch-name> -p
```

--------------------------------

### Install Git Town on Windows via Chocolatey

Source: https://www.git-town.com/print

Install Git Town on Windows using the Chocolatey package manager. Ensure Chocolatey is installed and configured.

```powershell
choco install git-town
```

--------------------------------

### Install Git Town on Debian-based Linux

Source: https://www.git-town.com/install

Download and install the .deb package for Debian-based Linux systems.

```bash
sudo apt-get install git-town_linux_intel_64.deb
```

--------------------------------

### Example Stack Before Detach

Source: https://www.git-town.com/commands/detach

Illustrates the branch stack structure before executing the detach command.

```bash
main
 \
  branch-1
   \
    branch-2
     \
      branch-3
```

--------------------------------

### Example 1: Moving a Branch to a New Parent

Source: https://www.git-town.com/print

Demonstrates how `set-parent` changes a branch stack when a branch is moved under a new parent.

```text
main
 \
  feature-1
   \
    feature-2
     \
      feature-3

 \
  feature-A

```

```bash
git town set-parent feature-A
```

```text
main
 \
  feature-1

 \
  feature-A
   \
    feature-2
     \
      feature-3

```

--------------------------------

### Git Town Merge Help Example

Source: https://www.git-town.com/commands/merge

Display help information for the git town merge command using the -h or --help flags.

```bash
git town merge -h
```

```bash
git town merge --help
```

--------------------------------

### Example Git Town Configuration File (TOML)

Source: https://www.git-town.com/configuration-file

This TOML file shows the default settings for Git Town configuration. Users must set the 'main' branch.

```toml
[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

```

--------------------------------

### Example Branch Stack

Source: https://www.git-town.com/print

Illustrates a typical branch stack scenario where the commit command is beneficial.

```text
main
 \
  refactor
   \
    feature
```

--------------------------------

### Example: Verbose Append

Source: https://www.git-town.com/print

Illustrates enabling verbose output with the --verbose flag to see all Git commands run under the hood.

```bash
git town append <branch-name> -v
```

--------------------------------

### Install Git Town on macOS via Homebrew

Source: https://www.git-town.com/install

Use Homebrew to install Git Town on macOS.

```bash
brew install git-town
```

--------------------------------

### Install Git Town on macOS via MacPorts

Source: https://www.git-town.com/install

Use MacPorts to install Git Town on macOS.

```bash
sudo port install git-town
```

--------------------------------

### Switch to Branches Matching Multiple Regexes

Source: https://www.git-town.com/commands/switch

This example shows how to switch to branches that match multiple regular expressions, including the main branch.

```bash
git town switch me- main
```

--------------------------------

### Example: Moving a Branch to a New Parent

Source: https://www.git-town.com/commands/set-parent

Demonstrates how to change the parent of 'feature-2' to 'feature-A', making 'feature-2' and its children siblings of 'feature-1'.

```bash
git town set-parent feature-A
```

--------------------------------

### Example 2: Making a Child Branch a Sibling

Source: https://www.git-town.com/print

Illustrates how `set-parent` can be used to make a branch a sibling to its previous parent.

```text
main
 \
  feature-1
   \
    feature-2
     \
      feature-3
       \
        feature-4

```

```bash
git town set-parent feature-1
```

```text
main
 \
  feature-1
   \
    feature-2
   \
    feature-3
     \
      feature-4

```

--------------------------------

### Compile Git Town from source using Go

Source: https://www.git-town.com/install

Compile the latest version of Git Town from source if you have the Go compiler installed.

```bash
go install github.com/git-town/git-town/v22@latest
```

--------------------------------

### Example Stack After Detach

Source: https://www.git-town.com/commands/detach

Shows the branch stack structure after the 'branch-2' has been detached.

```bash
main
 \
  branch-1
   \
    branch-3
 \
  branch-2
```

--------------------------------

### Open Repo Homepage with Firefox via CLI

Source: https://www.git-town.com/preferences/browser

Use the `--browser` flag with the `repo` command to specify a browser for opening the repository homepage. This example uses Firefox.

```bash
git-town repo --browser=firefox
```

--------------------------------

### Append Command Example: Creating a New Branch

Source: https://www.git-town.com/commands/append

Demonstrates how to create a new feature branch 'feature-2' as a child of the current branch 'feature-1'. This example assumes a clean Git workspace.

```bash
git town append feature-2
```

--------------------------------

### Switch to Observed Branches (Combined Short Flags)

Source: https://www.git-town.com/commands/switch

This example demonstrates combining short flags for type filtering, showing a more compact command syntax.

```bash
git town switch -to
```

--------------------------------

### Git Town Branch Structure Example

Source: https://www.git-town.com/print

Illustrates a typical Git branch hierarchy before creating a new feature branch.

```text
main
 \
  branch-1
   \
    branch-2
```

--------------------------------

### Prepend Command Example: Repository State After

Source: https://www.git-town.com/commands/prepend

Shows the repository's branch stack after successfully running 'git town prepend feature-1' from the 'feature-2' branch.

```text
main
 \
* feature-1
   \
    feature-2
```

--------------------------------

### Example Git Branch Stack Before Hack

Source: https://www.git-town.com/commands/hack

Illustrates a typical Git branch stack before executing the 'git town hack' command.

```text
main
 \
  branch-1
   \
*   branch-2
```

--------------------------------

### Swap Command Example: After

Source: https://www.git-town.com/commands/swap

Illustrates the branch stack structure after executing 'git town swap' on 'branch-2'. The branch has moved forward in the stack.

```bash
main
 \
  branch-2
   \
*   branch-1
     \
      branch-3
```

--------------------------------

### Example: Appending with Message

Source: https://www.git-town.com/print

Illustrates using the --message flag to specify a commit message when using the --commit flag.

```bash
git town append <branch-name> -m "My commit message"
```

--------------------------------

### Switch to Observed Branches by Type

Source: https://www.git-town.com/commands/switch

Use the --type flag to filter branches by their type. This example switches to branches of type 'observed'.

```bash
git town switch --type=observed
```

--------------------------------

### Example Git Branch Stack After Hack

Source: https://www.git-town.com/commands/hack

Shows the Git branch stack after running 'git town hack branch-3' when on 'branch-2'.

```text
main
 \
  branch-1
   \
    branch-2
 \
* branch-3
```

--------------------------------

### Example: Making a Branch a Sibling

Source: https://www.git-town.com/commands/set-parent

Shows how to make 'feature-3' a sibling of 'feature-2' by setting its parent to 'feature-1'. This effectively removes 'feature-3' from its original position in the stack.

```bash
git town set-parent feature-1
```

--------------------------------

### Example: Appending in Detached Mode

Source: https://www.git-town.com/print

Demonstrates enabling detached mode with the --detached flag, which prevents feature branches from receiving updates from the perennial branch.

```bash
git town append <branch-name> -d
```

--------------------------------

### Git Town Merge Dry Run Example

Source: https://www.git-town.com/commands/merge

Use the --dry-run flag to preview the Git commands that would be executed without actually running them.

```bash
git town merge --dry-run
```

--------------------------------

### Initialize Git Town Configuration

Source: https://www.git-town.com/configuration-file

Run this command to create a new git-town.toml configuration file.

```bash
git town init

```

--------------------------------

### Park Command Usage

Source: https://www.git-town.com/commands/park

This snippet shows the basic syntax for the 'park' command, including optional branch names and help flags.

```bash
git town park [<branch-name>...] [-h | --help] [-v | --verbose]
```

--------------------------------

### Prepend Command: --prototype Flag

Source: https://www.git-town.com/commands/prepend

Creates a prototype branch.

```bash
git town prepend --prototype
```

--------------------------------

### Prepend Command: --help Flag

Source: https://www.git-town.com/commands/prepend

Displays help information for the prepend command.

```bash
git town prepend --help
```

--------------------------------

### Prepend Command: --verbose Flag

Source: https://www.git-town.com/commands/prepend

Prints all Git commands run under the hood to determine the repository state.

```bash
git town prepend --verbose
```

--------------------------------

### Git Town Up with Order Flag

Source: https://www.git-town.com/commands/up

The --order flag allows customizing the order in which branches get displayed.

```bash
git town up --order desc
```

--------------------------------

### Display Help

Source: https://www.git-town.com/commands/diff-parent

Use -h or --help to display the help message for the diff-parent command.

```bash
git town diff-parent --help
```

--------------------------------

### Display Help for Observe Command

Source: https://www.git-town.com/commands/observe

Use the -h or --help flags to display the help information for the observe command.

```bash
git town observe -h
```

--------------------------------

### Propose Command Usage

Source: https://www.git-town.com/commands/propose

This is the general usage syntax for the 'propose' command, showing available flags and arguments.

```bash
git town propose [--no-auto-resolve] [(-b | --body) <text>] [(-f | --body-file) <path>] [--browser <executable> | --no-browser] [--dry-run] [-h | --help] [--non-interactive] [-s | --stack] [(-t | --title) <text>] [-v | --verbose]
```

--------------------------------

### Configure Breadcrumbs via Environment Variable

Source: https://www.git-town.com/preferences/proposal-breadcrumb

Set the GIT_TOWN_PROPOSAL_BREADCRUMB environment variable to configure whether branches get pushed manually in Git.

```bash
export GIT_TOWN_PROPOSAL_BREADCRUMB=stacks
```

--------------------------------

### Prototype Command Usage

Source: https://www.git-town.com/commands/prototype

Shows the general syntax for the 'git town prototype' command, including optional branch names and help flags.

```bash
git town prototype [<branch-name>...] [-h | --help] [-v | --verbose]
```

--------------------------------

### Set Global Sync Strategy

Source: https://www.git-town.com/preferences

Configure the default sync strategy for all repositories globally. Use this when you have a preferred strategy for all your projects.

```bash
git config --global git-town.sync-feature-strategy rebase
```

--------------------------------

### Override Config with Environment Variable

Source: https://www.git-town.com/preferences

Use environment variables to override Git Town configuration settings. This example shows loading a GitHub token from 1Password.

```bash
GIT_TOWN_GITHUB_TOKEN=$(op read op://development/GitHub/credentials/personal_token) git town config
```

--------------------------------

### Load Fish Completions

Source: https://www.git-town.com/commands/completions

Command to load Git Town auto-completion for Fish. Pipe to source and add to config.fish for persistence.

```fish
git town completions fish | source
```

--------------------------------

### View Git Repository in Browser

Source: https://www.git-town.com/print

Command to view the Git repository in the browser.

```bash
git town repo - view the Git repository in the browser
```

--------------------------------

### Display Help for Feature Command

Source: https://www.git-town.com/commands/feature

Use the -h or --help flag to display the help message for the 'git town feature' command.

```bash
git town feature -h
```

--------------------------------

### Compressing Commits on a Branch

Source: https://www.git-town.com/commands/compress

Example of compressing three commits on a feature branch into a single commit. The new commit retains the message of the first original commit.

```bash
git log --format='%s'
commit 1
commit 2
commit 3
```

```bash
git town compress
```

```bash
git log --format='%s'
commit 1
```

--------------------------------

### Git Town Config Get Parent Command Usage

Source: https://www.git-town.com/commands/config-get-parent

Displays the command-line syntax for retrieving the parent branch of a given or current branch using Git Town.

```bash
git town config get-parent [<branch-name>] [-h | --help] [-v | --verbose]
```

--------------------------------

### Configure Browser in Git Town Config File

Source: https://www.git-town.com/print

Set the `browser` key under the `[hosting]` section in the Git Town configuration file to specify a browser executable.

```ini
[hosting]
browser = "<browser executable>"

```

--------------------------------

### Prepend Command: --propose Flag

Source: https://www.git-town.com/commands/prepend

Proposes the created branch. If share-new-branches is configured, this creates a remote tracking branch.

```bash
git town prepend --propose
```

--------------------------------

### Configure Prototype Sync Strategy via Git Command

Source: https://www.git-town.com/preferences/sync-prototype-strategy

Use the `git config` command to set the prototype sync strategy. The `--global` flag makes the setting apply to all repositories.

```bash
git config [--global] git-town.sync-prototype-strategy <merge|rebase>

```

--------------------------------

### Display Git Town Configuration

Source: https://www.git-town.com/commands/config

Run the config command without any subcommands to view the current Git Town configuration settings for the repository.

```bash
git town config [(-d | --display-types) <type>] [-h | --help] [--redact] [-v | --verbose]
```

--------------------------------

### Prepend Command: --sync and --no-sync Flags

Source: https://www.git-town.com/commands/prepend

Enables or disables automatic syncing of the current branch before prepending the new one.

```bash
git town prepend --sync
```

```bash
git town prepend --no-sync
```

--------------------------------

### Park the Current Branch

Source: https://www.git-town.com/commands/park

Use this command to park the branch you are currently working on.

```bash
git town park
```

--------------------------------

### Display Git Town Help

Source: https://www.git-town.com/commands/help

Use this command to view detailed information about each Git Town command. The `-h` or `--help` flags display help for the specific command.

```bash
git town help [-h | --help]
```

--------------------------------

### Switch to Multiple Branch Types

Source: https://www.git-town.com/commands/switch

This command shows how to switch to branches that match multiple types, separated by '+'.

```bash
git town switch --type=observed+contribution
```

--------------------------------

### Load Bash Completions

Source: https://www.git-town.com/commands/completions

Command to load Git Town auto-completion for Bash. Add to .bashrc for persistence.

```bash
source <(git town completions bash)
```

--------------------------------

### Observe Command Syntax

Source: https://www.git-town.com/commands/observe

This is the general syntax for the observe command. It can take an optional branch name and flags for help or verbosity.

```bash
git town observe [<branch-name>...] [-h | --help] [-v | --verbose]
```

--------------------------------

### Prepend Command: --title Flag

Source: https://www.git-town.com/commands/prepend

Pre-populates the pull request title. Requires the --propose flag.

```bash
git town prepend --propose --title "My PR title"
```

--------------------------------

### Load Zsh Compinit

Source: https://www.git-town.com/commands/completions

Command to load Zsh's completion system, necessary if encountering 'command not found: compdef'.

```zsh
autoload -Uz compinit
```

--------------------------------

### Prepend Command: --body Flag

Source: https://www.git-town.com/commands/prepend

Pre-populates the pull request body. Requires the --propose flag.

```bash
git town prepend --propose --body "My PR body text"
```

--------------------------------

### Set up Zsh Autocompletion for Git Town

Source: https://www.git-town.com/print

This command loads Git Town's autocompletion scripts for Zsh. To make this permanent, add the command to your `.zshrc` file. If you encounter a `command not found: compdef` error, run `autoload -Uz compinit` first.

```zsh
source <(git town completions zsh)
```

```zsh
autoload -Uz compinit
```

--------------------------------

### Display Help for Config Remove

Source: https://www.git-town.com/commands/config-remove

Use the -h or --help flags to display the help message for the 'config remove' command.

```bash
git town config remove --help
```

--------------------------------

### Git Town Walk Command Usage

Source: https://www.git-town.com/commands/walk

This shows the basic syntax for the 'git town walk' command, including optional arguments.

```bash
git town walk [<command and arguments>] [-a | --all] [--dry-run] [-h | --help] [--(non)-interactive] [-s | --stack] [-v | --verbose]
```

--------------------------------

### Load Zsh Completions

Source: https://www.git-town.com/commands/completions

Command to load Git Town auto-completion for Zsh. Add to .zshrc for persistence.

```zsh
source <(git town completions zsh)
```

--------------------------------

### Configure Display Types via Git Config Command

Source: https://www.git-town.com/preferences/display-types

Use the 'git config' command to set the display-types configuration. The optional --global flag applies the setting to all repositories.

```git
git config [--global] git-town.display-types <push|propose>
```

--------------------------------

### Configuration File Setting (INI)

Source: https://www.git-town.com/preferences/ship-delete-tracking-branch

Alternatively, configure this option using INI-style syntax in your Git Town configuration file.

```ini
[ship]
delete-tracking-branch = true
```

--------------------------------

### Configure Ship Strategy in Git Town Config File

Source: https://www.git-town.com/preferences/ship-strategy

Set the ship strategy by adding the 'strategy' key under the '[ship]' section in your Git Town configuration file.

```ini
[ship]
strategy = "api"
```

--------------------------------

### Prepend Command: --dry-run Flag

Source: https://www.git-town.com/commands/prepend

Tests the command by printing the Git commands that would be run without executing them.

```bash
git town prepend --dry-run
```

--------------------------------

### Display Git Town Status Help

Source: https://www.git-town.com/commands/status

Shows help information for the `git town status` command.

```bash
git town status -h
```

--------------------------------

### Runlog Command Usage

Source: https://www.git-town.com/commands/runlog

Displays the basic usage of the git town runlog command, including help and verbose flags.

```bash
git town runlog [-h | --help] [-v | --verbose]
```

--------------------------------

### Configure Ship Strategy via Git Metadata

Source: https://www.git-town.com/preferences/ship-strategy

Manually configure the ship strategy using the 'git config' command. The optional '--global' flag applies the setting to all repositories.

```bash
git config [--global] git-town.ship-strategy <always-merge|api|fast-forward|squash-merge>
```

--------------------------------

### Switch to Multiple Branch Types (Shortened)

Source: https://www.git-town.com/commands/switch

This is a shortened version of the previous command, using combined short flags for multiple branch types.

```bash
git town switch -to+c
```

--------------------------------

### Order Branches Option

Source: https://www.git-town.com/commands/down

Allows customizing the order in which branches are displayed.

```bash
git town down --order <asc|desc>
```

```bash
git town down -o <asc|desc>
```

--------------------------------

### Set Local Sync Strategy

Source: https://www.git-town.com/preferences

Configure the sync strategy for a specific repository. This overrides global settings for the current repository.

```bash
git config git-town.sync-feature-strategy merge
```

--------------------------------

### Append Command with --propose Option

Source: https://www.git-town.com/commands/append

Proposes the created branch. This can be configured to be the default behavior.

```bash
git town append <branch-name> --propose
```

--------------------------------

### Open Repository in Browser

Source: https://www.git-town.com/commands/repo

Opens the homepage of the current repository in your default system browser. Git Town supports various hosting platforms like GitHub, GitLab, and Bitbucket. The browser can be configured via the BROWSER environment variable.

```bash
git town repo [<remote-name>] [--browser <executable> | --no-browser] [-h | --help] [-v | --verbose]
```

--------------------------------

### Configure GitHub Token via Git Config

Source: https://www.git-town.com/preferences/github-token

Set the GitHub personal access token for Git Town using the Git configuration command. The `--global` flag applies the setting to all repositories.

```bash
git config [--global] git-town.github-token <token>
```

--------------------------------

### Configure Browser in Git Config File

Source: https://www.git-town.com/preferences/browser

Set the browser executable path in the Git configuration file under the `[hosting]` section. This allows for persistent configuration.

```ini
[hosting]
browser = "<browser executable>"
```

--------------------------------

### Configure Stashing via Git Config

Source: https://www.git-town.com/preferences/stash

Configure stashing behavior using the 'git config' command. Use '--global' to apply to all repositories.

```bash
git config [--global] git-town.stash <true|false>

```

--------------------------------

### Display Help for Delete Command

Source: https://www.git-town.com/commands/delete

The -h or --help flags display the help information for the delete command.

```bash
git town delete -h
```

```bash
git town delete --help
```

--------------------------------

### Contribute Command Usage

Source: https://www.git-town.com/commands/contribute

Basic usage of the contribute command.

```bash
git town contribute [<branch-name>...] [-h | --help] [-v | --verbose]
```

--------------------------------

### Prepend Command: --beam Flag

Source: https://www.git-town.com/commands/prepend

Moves commits to the new parent branch, allowing selection via a visual dialog. Beaming suppresses all branch updates.

```bash
git town prepend --beam
```

--------------------------------

### Append Command with --prototype Option

Source: https://www.git-town.com/commands/append

Creates a prototype branch. This is an alias for the -p switch.

```bash
git town append <branch-name> --prototype
```
Tokens:
Raw