git-bug is a bug tracker that:
- is fully embeded in git: you only need your git repository to have a bug tracker
- is distributed: use your normal git remote to collaborate, push and pull your bugs!
- works offline: in a plane or under the sea? Keep reading and writing bugs!
- prevents vendor lock-in: your usual service is down or went bad? You already have a full backup.
- is fast: listing bugs or opening them is a matter of milliseconds
- doesn’t pollute your project: no files are added in your project
- integrates with your tooling: use the UI you like (CLI, terminal, web) or integrate with your existing tools through the CLI or the GraphQL API
- bridges to other bug trackers: use bridges to import and export to other trackers.
🚧 This is now more than a proof of concept, but still not fully stable. Expect dragons and unfinished business. 🚧
- Go to the release page and download the appropriate binary for your system.
- Copy the binary anywhere in your $PATH
- Rename the binary to
That’s all !
git clone firstname.lastname@example.org:MichaelMure/git-bug.git make install
If it’s not done already, add the golang binary directory in your PATH:
export PATH=$PATH:$(go env GOROOT)/bin:$(go env GOPATH)/bin
There is multiple ways to use
This is the pure
git-bug experience. In a similar fashion as with code, use
git bug push and
git bug pull to push and pull your bugs between git remotes and collaborate with your teammate.
git-bug has bridges with other bug-trackers, you can use it as your personal local remote interface. Sync with
git bug bridge pull and
git bug bridge push, work from your terminal, integrate into your editor, it’s up to you. And it works offline !
Often, projects needs to have their bug-tracker public and accept editions from anyone facing a problem. To support this workflow,
git-bug aims to have the web UI accept external OAuth authentication and act as a public portal. However the web UI is not up to speed for that yet. Contribution are very much welcome!
Create a new identity:
git bug user create
Create a new bug:
git bug add
Your favorite editor will open to write a title and a message.
You can push your new entry to a remote:
git bug push [<remote>]
And pull for updates:
git bug pull [<remote>]
List existing bugs:
git bug ls
Filter and sort bugs using a query:
git bug ls "status:open sort:edit"
You can now use commands like
close to display and modify bugs. For more details about each command, you can run
git bug <command> --help or read the command’s documentation.
Interactive terminal UI
An interactive terminal UI is available using the command
git bug termui to browse and edit bugs.
Web UI (status: WIP)
You can launch a rich Web UI with
git bug webui.
This web UI is entirely packed inside the same go binary and serve static content through a localhost http server.
The web UI interact with the backend through a GraphQL API. The schema is available here.
(can import more than once)
(download only new data)
|automated test suite||✔️||✔️||❌||❌|
|automated test suite||✔️||✔️||❌||❌|
Interactively configure a new github bridge:
git bug bridge configure
git bug bridge configure --name=<bridge> --target=github --url=https://github.com/MichaelMure/git-bug --login=<login> --token=<token>
git bug bridge pull [<name>]
git bug bridge push [<name>]
Deleting a bridge:
git bug bridge rm [<name>]
- media embedding
- more bridges
- extendable data model to support arbitrary bug tracker
- inflatable raptor
PRs accepted. Drop by the Gitter lobby for a chat or browse the issues to see what is worked on or discussed.
git clone email@example.com:MichaelMure/git-bug.git
You can now run
make to build the project, or
make install to install the binary in
To work on the web UI, have a look at the dedicated Readme.
Thank you to all our backers! 🙏 [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
Unless otherwise stated, this project is released under the GPLv3 or later license © Michael Muré.
The git-bug logo by Viktor Teplov is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) license © Viktor Teplov.