Distributed, offline-first bug tracker embedded in git, with bridges
Go to file
2018-09-17 14:36:51 +02:00
bug docs & cleaning 2018-09-16 13:50:53 +02:00
cache docs & cleaning 2018-09-16 13:50:53 +02:00
commands commands: add a "label rm" command to remove labels from a bug 2018-09-17 14:36:51 +02:00
doc commands: add a "label rm" command to remove labels from a bug 2018-09-17 14:36:51 +02:00
graphql docs & cleaning 2018-09-16 13:50:53 +02:00
input docs & cleaning 2018-09-16 13:50:53 +02:00
misc commands: add a "label rm" command to remove labels from a bug 2018-09-17 14:36:51 +02:00
operations commands: add a "label add" command to add new label to a bug 2018-09-17 14:33:34 +02:00
repository lamport: better perf by ensuring that the folder is created only once 2018-09-13 16:05:27 +02:00
termui docs & cleaning 2018-09-16 13:50:53 +02:00
tests bug: add a data validation process to avoid merging incorrect operations 2018-09-15 13:15:00 +02:00
util commands: git bug comment now show the comments of a bug 2018-09-15 20:30:31 +02:00
vendor graphql: update gqlgen to 0.5.1 2018-09-14 12:41:59 +02:00
webui docs & cleaning 2018-09-16 13:50:53 +02:00
.gitignore upgrade the readme 2018-08-06 03:26:42 +02:00
.travis.yml travis: clean outdated build tag 2018-09-07 16:16:10 +02:00
git-bug.go webui: pack the files only on demand 2018-08-06 16:17:11 +02:00
Gopkg.lock graphql: update gqlgen to 0.5.1 2018-09-14 12:41:59 +02:00
Gopkg.toml graphql: update gqlgen to 0.5.1 2018-09-14 12:41:59 +02:00
LICENSE Create LICENSE 2018-07-12 12:54:04 +02:00
Makefile invert the behavior of the build flag for the webui 2018-09-02 00:06:50 +02:00
README.md Added backers and sponsors on the README 2018-09-13 09:15:32 -07:00

git-bug

Distributed bug tracker embedded in Git.

Build Status Backers on Open Collective Sponsors on Open Collective License: GPL v3 GoDoc Go Report Card Gitter chat

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.

🚧 This is for now a proof of concept. Expect dragons and unfinished business. 🚧

Install

Go get

go get -u github.com/MichaelMure/git-bug

If it's not done already, add golang binary directory in your PATH:

export PATH=$PATH:$GOROOT/bin:$GOPATH/bin

Pre-compiled binaries

  1. Go to the release page and download the appropriate binary for your system.
  2. Copy the binary anywhere in your PATH
  3. Rename the binary to git-bug (or git-bug.exe on windows)

That's all !

Linux packages

CLI usage

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 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.

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.

Web UI screenshot 1 Web UI screenshot 2

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.

Internals

Interested by how it works ? Have a look at the data model.

Misc

Planned features

  • media embedding
  • import/export of github issue
  • extendable data model to support arbitrary bug tracker
  • inflatable raptor

Contribute

PRs accepted. Drop by the Gitter lobby for a chat.

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

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.