git-bug is a bug tracker that:
- is completely embedded in git: you lone need your git repository to have a bug tracker
- is distributed: use your normal git distant to collaborate, shove and drag your bugs!
- works offline: in a aircraft or under the sea? Keep study and penning bugs!
- prevents vendor lock-in: your customary assistance is downward or went bad? You already have a complete backup.
- is fast: listing bugs or beginning them is a matter of milliseconds
- doesn't pollute your project: no records are added in your project
- integrates alongside your tooling: use the UI you akin (CLI, terminal, web) or merge alongside your existing tools through the CLI or the GraphQL API
- bridges to another bug trackers: use bridges to import and export to another trackers.
See INSTALLATION.md for the complete guide, including how to build from origin and verify your install.
There are multiple ways to use git-bug. See the workflow documentation for the details.
Native workflow 
This is the clean git-bug experience. In a akin manner as alongside code, use git bug shove and git bug drag to shove and drag your bugs between git remotes and collaborate alongside your teammate.
Bridge workflow 
As git-bug has bridges alongside another bug-trackers, you can use it as your individual local distant interface. Sync alongside git bug extend drag and git bug extend push, activity from your terminal, merge into your editor, it's up to you. And it plant offline!
Web UI workflow (WIP) 
Often, projects need to have their bug-tracker community and obtain editions from anyone facing a problem. To assistance this workflow, git-bug aims to have the web UI obtain external OAuth authentication and act as a community portal. However the web UI is not up to speed for that yet. Contributions are extremely much welcome!
Create a new identity:
Create a new bug:
Your favorite publishing company volition open to compose a heading and a message.
You can shove your new admission to a remote:
And drag for updates:
List existing bugs:
Filter and kind bugs using a query:
git bug ls "status:open sort:edit"Search for bugs by content content:
You can now use commands akin show, comment, open or near to display and modify bugs. For additional particulars concerning all command, you can run git bug <command> --help or peruse the command's documentation.
An interactive terminal UI is accessible using the command git bug termui to browse and edit bugs.
You can initiate a affluent Web UI alongside git bug webui. Browse, hunt and display issues, open new ones, comment, and edit titles, labels and status. It additionally doubles as a code browser for your repository, alongside a document tree, syntax-highlighted files, commit former and diffs.
The web UI is packed inner the identical go binary and served by a local http server. It talks to the backend through a GraphQL API, whose schema is accessible here.
git-bug can import from and export to Github, Gitlab, Jira and Launchpad. See the feature matrix for what all extend supports, and the bridge documentation for the complete guide.
Interactively configure a new bridge:
Or manually:
git bug extend new \ --name=<bridge> \ --target=github \ --url=https://github.com/git-bug/git-bug \ --login=<login> \ --token=<token>
Import bugs:
git bug extend drag [<name>]
Export modifications:
git bug extend shove [<name>]
Delete a bridge:
git bug extend rm [<name>]
Interested in how it works? Have a appearance at the data model and the internal bird-view.
The on-disk format is formally stated in the git-bug spec, covering the DAG being format, identities and the bug entity. Read that if you desire to compose another implementation or a tool that says git-bug data directly.
Or perchance you desire to make your own distributed data-structure in git?
See additionally all the docs.
The feature matrix gives a fine overview of what is planned, without being exhaustive.
Additional planned features:
- webUI that can be used as a community portal to obtain user's input
- inflatable raptor
PRs accepted. Drop by the Matrix room for a chat, appearance at the feature matrix or browse the issues and discussions to see what is worked on or discussed.
See CONTRIBUTING.md to get a betterment surroundings going, build the project and run the tests. To activity on the web UI, have a appearance at its dedicated README.
This project exists gratitude to all the group who contribute.
Thank you to all our backers and sponsors! 🙏 [Become a backer or sponsor]
Unless alternatively stated, this project is released under the GPLv3 or afterward licence © Michael Muré.
The git-bug logo by Viktor Teplov is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) licence © Viktor Teplov.
