Would it be nice to not have to rely on a web service somewhere to deal with bugs ?
Would it be nice to be able to browse and edit bug reports offline?
git-bug is a distributed bug tracker embedded in
git. It uses git's internal storage so no files are added in your project.
As you would do with commits and branches, you can push your bugs to the same git remote you are already using to collaborate with other people.
go get -u github.com/MichaelMure/git-bug
If it's not done already, add golang binary directory in your PATH:
export PATH=$PATH:$(go env GOROOT)/bin:$(go env GOPATH)/bin
- 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 !
Create a new bug:
git bug new
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.
Interested by how it works ? Have a look at the data model.
- media embedding
- import/export of github issue
- extendable data model to support arbitrary bug tracker
- inflatable raptor
PRs accepted. Drop by the Gitter lobby for a chat.
Thank you to all our backers!
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.