GitterDone

A tiny CLI tool for creating project branches that match the branching strategy stored in the project.

GitHub Flow is the default: main is the only long-lived branch, work branches from main, and changes return through pull requests after review and CI.

Install for local use

npm install
npm link

After linking, both commands are available:

gd help
gitterdone help

Initialize a project

From the root of a project:

gd init

This creates .gitterdone.json, initializes git for the selected strategy, and prompts to create the first commit when the repo has no commits yet.

For GitHub Flow, gd init ensures the project is a git repo on main.

For Gitflow, gd init ensures main exists and creates develop when the repo already has an initial commit.

To create the first commit without prompting while initializing a brand-new repo:

gd init --initial-commit

You can customize the commit message:

gd init --initial-commit --commit-message "Bootstrap project"

For Gitflow in a brand-new repo, the initial commit lets gd init create develop immediately:

gd init --strategy gitflow --initial-commit

To skip prompts:

gd init --strategy github-flow

To write only the dotfile without changing git:

gd init --no-git

Create a branch

Interactive mode:

gd branch

Non-interactive mode:

gd branch --type feat --description "add user invites" --yes

Preview without touching git:

gd branch --type fix --description "resolve login loop" --dry-run

gd branch creates and checks out the branch for you. It also checks the configured strategy before branching:

• GitHub Flow work branches start from main.
• Gitflow feature/fix/chore/refactor/docs/test/perf/spike/release branches start from develop.
• Gitflow hotfix branches start from main.

Use --base to override the base branch for a one-off branch:

gd branch --type fix --description "patch signup redirect" --base main --yes

The default branch types are:

feat/short-description
fix/short-description
chore/short-description
refactor/short-description
docs/short-description
test/short-description
perf/short-description
spike/short-description