git-extras README

The project's README from github.com/tj/git-extras. As one markdown file: README.md.

Git Extras

Little git extras.

Screencasts

Just getting started? Check out these screencasts:

Installation

See the Installation page.

Commands

Go to the Commands page for basic usage and examples.

GIT utilities -- repo summary, repl, changelog population, author commit percentages and more

Contributing

Interested in contributing? Awesome!

Please read Contributing before you make a PR, thanks!

The change of the default branch

As of Git Extras 6.4 the assumed default branch name changed from master to main. This affects the Git Extras commands git archive-file, git delete-merged-branches, git delta, git pull-request, git show-merged-branches, git show-unmerged-branches, and git squash.

To change the default branch name to master: change either the configuration git-extras.default-branch or init.defaultBranch to master; the former takes precedence.

For example, git config git-extras.default-branch master.

git-extras (tj/git-extras)

Searching Database…

What is this?git-extras is a collection of extra Git commands that add missing conveniences: repo summaries, a changelog generator, release tagging, author contribution stats, and more.
Is this a standalone app or a set of git subcommands?It is a set of shell script subcommands that plug into git, so you run them like any native git command (e.g. git effort, git changelog).
Do I need anything besides git itself?Just Git and a Unix-like shell environment; the scripts are plain Shell and use make for installation.
Does changing the default branch from master to main break anything?Since version 6.4 the default branch changed from master to main, which affects commands like git archive-file, git delete-merged-branches, git delta, git pull-request, git show-merged-branches, git show-unmerged-branches, and git squash; you can revert by setting git-extras.default-branch to master.
What kind of commands does it add?Commands for repo summaries, a changelog generator, release helpers, and author commit percentage stats, among many others covered on the project's Commands page.
Where can I see it in action before installing?The README links to screencasts covering commands like git-ignore, git-setup, git-changelog, git-release, and git-effort.
How do I revert to using master as the default branch name?Set the git-extras.default-branch config (or init.defaultBranch) to master, e.g. git config git-extras.default-branch master.
Creator
tj
Size
2.3 MB
Stars
18.1K
Age
16y
Commits · 90 Days