git-bug
is a bug tracker that:
:construction: This is now more than a proof of concept, but still not fully stable. Expect dragons and unfinished business. :construction:
This project has grown bigger than I can handle by myself, especially with a day job. I'm looking for people to help on or maintain part of it:
Individually, those pieces are not especially complex but doing everything make it hard for me to focus on the core where things get more complicated. If this is useful for you or you just want to join the fun, maybe consider it?
There are multiple ways to use git-bug
:
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.
As `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"
Search for bugs by text content:
git bug ls "foo bar" baz
You can now use commands like show
, comment
, open
or 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.
An interactive terminal UI is available using the command git bug termui
to browse and edit bugs.
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.
Github | Gitlab | Jira | Launchpad | |
---|---|---|---|---|
incremental (can import more than once) |
:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
with resume (download only new data) |
:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
identities | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
identities update | :x: | :x: | :x: | :x: |
bug | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
comments | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
comment editions | :heavy_check_mark: | :x: | :heavy_check_mark: | :x: |
labels | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
status | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
title edition | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
media/files | :x: | :x: | :x: | :x: |
automated test suite | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: |
Github | Gitlab | Jira | Launchpad | |
---|---|---|---|---|
bug | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
comments | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
comment editions | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
labels | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
status | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
title edition | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: |
automated test suite | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: |
Interactively configure a new github bridge:
git bug bridge configure
Or manually:
git bug bridge configure \
--name=<bridge> \
--target=github \
--url=https://github.com/MichaelMure/git-bug \
--login=<login>
--token=<token>
Import bugs:
git bug bridge pull [<name>]
Export modifications:
git bug bridge push [<name>]
Deleting a bridge:
git bug bridge rm [<name>]
Interested by how it works ? Have a look at the data model and the internal bird-view.
PRs accepted. Drop by the Gitter lobby for a chat or browse the issues to see what is worked on or discussed.
git clone git@github.com:MichaelMure/git-bug.git
You can now run make
to build the project, or make install
to install the binary in $GOPATH/bin/
.
To work on the web UI, have a look at the dedicated Readme.
This project exists thanks to all the people who contribute.
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.