V3.2.7

What's Changed

• Register branch with alias after successful worktree creation (#37)

Full Changelog: V3.2.6...V3.2.7

---

Overview

A bash tool to facilitate managing git branches with long cryptic names with aliases

The gitBranchTool, g, command provides additional functionalities around working with git branches.

If you frequently work with long branch names that include developer names, project names, issue numbers, and etc this tool is for you. With gitBranchTool or g, you'll be able to assign alias names for each branch.

You can monitor, switch, and delete your branches using the aliases instead of the long and confusing branch names (g commands support both branch names and aliases, so you wouldn't have to use git for any of your branch switching needs).

Additionally, You can add notes to each branch to fully remember what they were about so you can keep the aliases shorter. You can list branches with their aliases and notes at anytime.

g also provides auto-completion for branch names and aliases, so you wouldn't even have to type the full alias name.

On top of all these, g provides a custom prompt that displays the name of the current repository, sub-directory, branch name, and its alias.

Installation

Linux

1. Download the artifact g-linux-vX.X.X from the latest release here

2. Add the binary to your PATH environment variable (or to a directory that is already in your PATH)

   A directory that is already in your PATH is /usr/local/bin/ or /usr/bin/

sudo mv g-linux-vX.X.X /usr/local/bin/g

3. Ensure the binary has the correct permissions

sudo chmod 755 /usr/local/bin/g

MacOS

1. Download the artifact g-macos-vX.X.X from the latest release here

2. Add the binary to your PATH environment variable (or to a directory that is already in your PATH)

   A directory that is already in your PATH is /usr/local/bin/ or /usr/bin/

sudo mv g-macos-vX.X.X /usr/local/bin/g

3. Ensure the binary has the correct permissions

sudo chmod 755 /usr/local/bin/g

Windows (PowerShell)

1. Download the artifact g-win-vX.X.X from the latest release here

2. Add the binary to your PATH environment variable (or to a directory that is already in your PATH)

   A directory that is already in your PATH is C:\Windows\System32\ (you may need to run PowerShell as an administrator)

Move-Item -Force -Path .\g-win-vX.X.X.exe -Destination C:\Windows\System32\g.exe

Auto-Completion

For auto-completion, you can run the following commands based on your shell:

Linux Bash

sudo mkdir -p /etc/bash_completion.d && sudo touch /etc/bash_completion.d/g && USER=$(whoami); sudo chown $USER /etc/bash_completion.d/g && sudo chmod 755 /etc/bash_completion.d/g && sudo g completion bash > /etc/bash_completion.d/g"

MacOS Bash

echo "\nautoload -U compinit; compinit" >> ~/.bashrc
sudo mkdir -p /etc/bash_completion.d && sudo touch /etc/bash_completion.d/g && USER=$(whoami); sudo chown $USER /etc/bash_completion.d/g && sudo chmod 755 /etc/bash_completion.d/_g && sudo g completion bash > /etc/bash_completion.d/g"

Linux ZSH

sudo mkdir -p ${fpath[1]} && sudo touch ${fpath[1]}/_g && USER=$(whoami); sudo chown $USER ${fpath[1]}/_g && sudo chmod 755 ${fpath[1]}/_g && sudo g completion zsh > "${fpath[1]}/_g"

MacOS ZSH

echo "\nautoload -U compinit; compinit" >> ~/.zshrc
sudo mkdir -p ${fpath[1]} && sudo touch ${fpath[1]}/_g && USER=$(whoami); sudo chown $USER ${fpath[1]}/_g && sudo chmod 755 ${fpath[1]}/_g && sudo g completion zsh > "${fpath[1]}/_g"

Windows PowerShell

For default PowerShell profile file, run the following command:

echo "g completion powershell | Out-String | Invoke-Expression" >> $PROFILE

Custom Prompt

Linux/MacOS

Run the following command to add the gitBranchTool custom prompt to your shell profile file:

• Change .bashrc with .zshrc if you use ZSH, or the profile file you use if it's different.

echo -e "\nPROMPT_COMMAND='export PS1=\"\$(g _ps)\"'\nprecmd() { eval \"\$PROMPT_COMMAND\"; }" >> ~/.bashrc

Windows PowerShell

Run the following command to add the gitBranchTool custom prompt to your PowerShell profile file:

echo "function prompt { g _ps }" >> $PROFILE

Commands

A bash tool to facilitate managing git branches with long cryptic names with aliases

Usage:
  g [command]

Available Commands:
  addAlias         Adds alias and note to a branch that is not stored yet
  completion       Generate the autocompletion script for the specified shell
  create           Creates a branch with name, alias, and note, and checks into it
  currentBranch    Returns the name of active branch with alias and note
  delete           Deletes listed branches base on name or alias
  get              Get configuration options (Run `g get --help` for more information)
  getBranchAlias   Gets the branch alias
  help             Help about any command
  list             Lists all branches with their name, alias, and notes
  removeEntry      Removes a registered branch entry without deleting the branch
  rename           Updates the alias for the given branch name
  resolveAlias     Resolves the branch name from an alias
  set              Set configuration options (Run `g set --help` for more information)
  switch           Switches to the branch with the given name or alias
  updateBranchNote Adds/updates the notes for a branch base on name/alias
  updateCheck      Checks if a newer version is available
  worktree         Manage git worktrees (Run `g worktree --help` for more information)

Flags:
  -h, --help      help for g
  -N, --no-log    no logs
  -V, --verbose   verbose output
  -v, --version   version for g

Use "g [command] --help" for more information about a command.

Worktrees

Git worktrees allow you to have multiple working directories attached to the same repository, enabling you to work on different branches simultaneously without switching. gitBranchTool provides first-class support for managing worktrees with the same alias/note workflow you use for branches.

All worktree features are opt-in and do not affect users who don't use worktrees.

Worktree Commands

Command	Alias	Description
g worktree	g w	Shows worktree help and lists all worktrees
g worktree create ALIAS [BRANCH] [...NOTE]	g w c	Create a new worktree
g worktree list	g w l	List all worktrees (registered and unregistered)
g worktree delete [...PATH|ALIAS] [--force]	g w d	Delete worktree(s) by alias or path
g worktree prune	g w p	Remove stale worktree entries

g worktree create behavior:

• If BRANCH is provided and matches a registered branch (by name or alias), the worktree is created for that branch and the branch is auto-registered if not already.
• If BRANCH is provided but not found in registered branches, the worktree is created with that branch as-is. If the branch doesn't exist in git, a new branch is created but is not automatically registered (use g addAlias <branch> <alias> to register it).
• If BRANCH is omitted, a new branch is created using the alias as the branch name.

g worktree list shows all worktrees from git worktree list, including those created outside of gitBranchTool. Registered worktrees display their alias and note.

g worktree delete accepts both aliases and full paths, so you can delete worktrees created outside of gitBranchTool as well.

g worktree prune runs git worktree prune first, then removes any stored entries whose paths no longer exist.

Worktree Integration with Branch Commands

Existing branch commands support an optional -w flag for worktree integration:

Command	Description
g create NAME ALIAS [...NOTE] -w	Create a new branch and a worktree for it (branch is not checked out in the current directory)
g create NAME ALIAS [...NOTE] -w=WT_ALIAS	Same as above, but with a custom worktree alias
g switch NAME/ALIAS -w	Find the worktree for a branch and print its path. If no worktree exists, create one
g delete NAME/ALIAS -w	Delete a branch and its associated worktree
g list	When worktrees exist, the branch list shows a "Worktree" column with the alias or path

Note: To specify a custom worktree alias with -w, use the = syntax: -w=my-alias. The space-separated form (-w my-alias) is not supported due to CLI parsing limitations.

Worktree Settings

Setting	Command	Description
worktree-path	g set worktree-path <TEMPLATE>	Path template for new worktrees. Available variables: {repository}, {alias}, {branch}. Default: ./worktrees/{alias}
delete-branches-worktree	g set delete-branches-worktree <true|false|null>	Controls worktree deletion when a branch is deleted. true: auto-delete, false: never delete, null: prompt (default)

Retrieve settings with g get worktree-path and g get delete-branches-worktree.