Generic, high-level Git workflow support!
Permalink
Failed to load latest commit information.
.github Charlie and Kevgo are code owners (#1057) Nov 22, 2017
documentation Verify command documentation via Text-Runner (#1161) Aug 30, 2018
features fix command unfinished after abort (#1176) Sep 15, 2018
package Markdown Autoformatter (#1064) Dec 5, 2017
src fix command unfinished after abort (#1176) Sep 15, 2018
text-run Verify Make commands (#1171) Sep 6, 2018
vendor update dependencies, add stripansi (#1134) Apr 9, 2018
website Fix uninstall command for Debian/Ubuntu distros (#1169) Aug 30, 2018
.editorconfig Specify source code formatting Nov 16, 2014
.gitignore use build flags (#1137) Apr 17, 2018
.hound.yml Fix HoundCI configuration Mar 25, 2015
.rubocop.yml Add Harp dev dependency (#1170) Aug 30, 2018
.ruby-version Ruby 2.4.1 Aug 7, 2017
.travis.yml Verify command documentation via Text-Runner (#1161) Aug 30, 2018
CONTRIBUTING.md Verify Make commands (#1171) Sep 6, 2018
Gemfile Remove Rake (#1051) Dec 3, 2017
Gemfile.lock Remove Rake (#1051) Dec 3, 2017
LICENSE Update LICENSE to 2018 (#1160) Jun 28, 2018
Makefile Cross-platform Makefile (#1173) Sep 6, 2018
README.md Document offline mode (#1146) May 25, 2018
RELEASE_NOTES.md Verify command documentation via Text-Runner (#1161) Aug 30, 2018
cucumber.yml resolves #199: command list architecture Dec 15, 2014
cucumber_lint.yml refactor steps to use tables Dec 26, 2016
doc.go Godoc (#1058) Nov 22, 2017
glide.lock update dependencies, add stripansi (#1134) Apr 9, 2018
glide.yaml update dependencies, add stripansi (#1134) Apr 9, 2018
main.go move all go code into src folder (#889) Apr 28, 2017
package.json Update dependencies (#1172) Sep 6, 2018
tertestrial.yml Verify command documentation via Text-Runner (#1161) Aug 30, 2018
text-run.yml Verify command documentation via Text-Runner (#1161) Aug 30, 2018
yarn.lock Update dependencies (#1172) Sep 6, 2018

README.md

Git Town

Build Status Go Report Card License Help Contribute to Open Source

Git Town makes software development teams who use Git even more productive and happy. It adds Git commands that support GitHub Flow, Git Flow, the Nvie model, GitLab Flow, and other workflows more directly, and it allows you to perform many common Git operations faster and easier.

See git-town.com for documentation and this Softpedia article for an independent review.

Commands

Git Town provides these additional Git commands:

Development Workflow

Repository Maintenance

Git Town Configuration

Other Commands

Installation

Since version 4.0, Git Town runs natively on all platforms without any dependencies. Check out our installation instructions for more details.

Aliasing

Each command can be aliased individually to remove the town prefix with:

git config --global alias.hack 'town hack'

Now you can run git hack instead of git town hack. As a convenience, you can add or remove global aliases for all git-town commands with:

git town alias <true | false>

Configuration

Git Town is configured on a per-repository basis. Upon first use in a repository, you will be prompted for the required configuration. Use the git town config command to view or update your configuration at any time.

Required configuration

Optional Configuration

The following configuration options have defaults, so the configuration wizard does not ask about them.

  • the pull branch strategy

    • how to sync the main branch / perennial branches with their upstream
    • default: rebase
    • possible values: merge, rebase
  • the new branch push flag

    • whether or not branches created by hack / append / prepend should be pushed to remote repo
    • default: false
    • possible values: true, false

Documentation

In addition to the online documentation here, you can run git town on the command line for an overview of the Git Town commands, or git help <command> (e.g. git help sync) for help with an individual command.

Contributing

Found a bug or have an idea for a new feature? Open an issue or - even better - get down, go to town, and fire a feature-tested pull request our way! Check out our contributing guide to start coding.