A Git CLI tool for intelligently creating branch names
Project description
gibr
🧩 A smarter CLI for creating Git branches.
gibr connects your Git workflow to your issue tracker — instantly creating consistent, descriptive branches.
Fully configurable, and ready for any tracker or team setup.
Currently supporting integration with:
Usage
# List open issues
$ gibr issues
| Issue | Type | Title | Assignee |
|---------|--------|---------------------------------------|------------|
| 123 | issue | Add support for OAuth2 / login (beta) | ytreister |
| 97 | issue | Add support for gitlab | |
# Decide which issue to work
$ gibr 123
Generating branch name for issue #123: Add support for OAuth2 / login (beta)
Branch name: ytreister/issue/123/add-support-for-oauth2-login-beta
✅ Created branch 'ytreister/issue/123/add-support-for-oauth2-login-beta' from main.
✅ Checked out branch: ytreister/issue/123/add-support-for-oauth2-login-beta
✅ Pushed branch 'ytreister/issue/123/add-support-for-oauth2-login-beta' to origin.
🚀 Quick start
Installation
Install the base package
pip install gibr
or if you use uv
uv pip install gibr
🧩 Optional dependencies
gibr supports multiple issue trackers, but you only need to install the dependencies for the ones you actually use.
Each tracker’s client library is an optional extra.
| Tracker | Extra name | Install command (can prepend with uv if you use it) |
|---|---|---|
| GitHub | github |
pip install gibr[github] |
| GitLab | gitlab |
pip install gibr[gitlab] |
| Jira | jira |
pip install gibr[jira] |
| Linear | built-in | N/A |
Note: You can also install multiple trackers at once, for example:
pip install gibr[github,jira]
Initial setup
Run gibr init to set up your configuration interactively. This will create a .gibrconfig file in your project root with the correct format for your chosen issue tracker.
Setup git aliases commands (optional)
Run gibr alias to set up git alias commands for your conveinence. This essentially allows you to extend the git CLI with gibr commands. See alias command for more details
Commands
init
gibr includes an init command to help you create your .gibrconfig file. See the following usage example:
$ gibr init
Welcome to gibr setup! Let’s get you started 🚀
Which issue tracker do you use?
1. GitHub
2. GitLab
3. Jira
4. Linear
5. Monday.com (coming soon)
Select a number (1, 2, 3, 4, 5) [1]: 1
GitHub selected.
GitHub repository (e.g. user/repo): ytreister/gibr
Environment variable for your GitHub token [GITHUB_TOKEN]:
🎉 Found GitHub token in environment (GITHUB_TOKEN)
.gibrconfig already exists. Overwrite? [y/N]: y
✅ Created .gibrconfig with GitHub settings
You're all set! Try: `gibr issues`
alias
gibr includes a built-in helper that writes git aliases into your global
~/.gitconfig for you. Run:
gibr alias
This adds aliases such as git create so that instead of using the gibr CLI directly, you can use an extended version of git:
git create 123
The above command is equivalent to using the CLI as follows: gibr 123 or
gibr create 123.
Flag order
The flag order when using the git alias version is different:
# ✅ gibr CLI (flags before)
gibr --verbose create 123
# ✅ git alias (flags after)
git create 123 --verbose
# ❌ wrong: flags after gibr CLI
gibr create 123 --verbose
# ❌ wrong: flags before the alias
git --verbose create 123
issues
Run gibr issues (or git issues) to view open issues in the issue tracker you have configured
create
Run gibr 123 (or gibr create 123 or git create 123) to create a branch for the cooresponding issue number.
Branch naming convention
gibr uses the branch_name_format from your .gibrconfig to determine the format for the branch.
You can use the following placeholders:
{issuetype}{issue}{title}{assignee}(Note: If issue does not have an assignee and your branch name format contains assignee, you will not be able to create the branch)
Special case: Jira
For Jira, you can specify a project_key in your configuration:
[jira]
project_key=FOO
If you do this, you can choose to either specify the entire issue id or just the numerical portion (i.e. FOO-123 or 123
# List issues
$ gibr issues
| Issue | Type | Title | Assignee |
|---------|---------|-------------|------------|
| FOO-3 | Subtask | Subtask 2.1 | ytreister |
| FOO-2 | Story | Task 2 | |
# Create branch for FOO-3
$ gibr 3
Generating branch name for issue FOO-3: Subtask 2.1
Branch name: FOO-3-subtask-2-1
✅ Created branch 'FOO-3-subtask-2-1' from main.
✅ Checked out branch: FOO-3-subtask-2-1
✅ Pushed branch 'FOO-3-subtask-2-1' to origin.
Optional flags
--verbose— enable debug-level logging for a command
Roadmap
See the Roadmap for upcoming features and plans.
Opensource contributions
See the Contributing guidelines if you would like to contribute.
💬 Feedback welcome!
Found a bug or have a feature request? Open an issue or start a discussion.
If you find it useful, consider starring ⭐️ the repo — it really helps visibility!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gibr-0.6.0.tar.gz.
File metadata
- Download URL: gibr-0.6.0.tar.gz
- Upload date:
- Size: 67.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
763695e9ce778119f14ad6080178fa4febc417846ebe4559182c8bb77ba9a18f
|
|
| MD5 |
3860d7be01d4900612131b9945b1bffd
|
|
| BLAKE2b-256 |
f2c47c17161d28cdc37b306dab8e79daef9d84a3b336392cc468ea0a8653390f
|
File details
Details for the file gibr-0.6.0-py3-none-any.whl.
File metadata
- Download URL: gibr-0.6.0-py3-none-any.whl
- Upload date:
- Size: 22.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a3fac4664b8cb704845d7258ca7cac1e83c34e14eee8cc8ab0f4ffa6d9793d6
|
|
| MD5 |
6b1b3229465425fc2d2cbbf6bb361f0f
|
|
| BLAKE2b-256 |
2f03143be3db0c04131fcae5e68a8ac13b2f7a3ce76c186fac040dc892d9229c
|