Distributed, offline-first bug tracker embedded in git, with bridges
Go to file
2019-03-27 21:44:11 +01:00
bridge github: fix potential bug due to var aliasing 2019-03-01 23:07:24 +01:00
bug cache: properly push/pull identities and bugs 2019-03-27 21:44:11 +01:00
cache cache: properly push/pull identities and bugs 2019-03-27 21:44:11 +01:00
commands cache: properly push/pull identities and bugs 2019-03-27 21:44:11 +01:00
doc cache: make the title filter case insensitive 2019-03-03 15:23:20 +01:00
entity cache: properly push/pull identities and bugs 2019-03-27 21:44:11 +01:00
graphql a round of cleanup 2019-03-01 22:52:53 +01:00
identity cache: properly push/pull identities and bugs 2019-03-27 21:44:11 +01:00
input Made requested changes 2019-03-02 23:06:55 +05:30
misc cache: make the title filter case insensitive 2019-03-03 15:23:20 +01:00
repository a round of cleanup 2019-03-01 22:52:53 +01:00
termui cache: properly push/pull identities and bugs 2019-03-27 21:44:11 +01:00
tests identity: add more test for serialisation and push/pull/merge + fixes 2019-03-01 22:40:24 +01:00
util commands: show the last modification time in "user" 2019-03-01 22:52:54 +01:00
vendor identity: more cleaning and fixes after a code review 2019-03-01 22:40:22 +01:00
webui upgrade webui dependency 2019-01-07 22:51:55 +01:00
.gitignore gitignore: ignore jetbrains project files 2018-12-05 19:43:20 +01:00
.travis.yml travis: build on all go and nodejs version supported 2018-12-23 23:02:25 +01:00
git-bug.go add a check for the minimal go version (1.8) 2018-12-23 23:03:19 +01:00
Gopkg.lock identity: more cleaning and fixes after a code review 2019-03-01 22:40:22 +01:00
Gopkg.toml termui: use a forked gocui to fix large character handling 2018-12-25 20:49:54 +01:00
LICENSE Create LICENSE 2018-07-12 12:54:04 +02:00
Makefile a round of cleanup 2019-03-01 22:52:53 +01:00
README.md chore(opencollective): use tiers 2019-01-21 11:17:06 +01: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:$(go env GOROOT)/bin:$(go env 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 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 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.

Termui recording

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
  • exporter to github issue
  • extendable data model to support arbitrary bug tracker
  • inflatable raptor

Contribute

PRs accepted. Drop by the Gitter lobby for a chat or browse the issues to see what is worked on or discussed.

Developers unfamiliar with Go may try to clone the repository using "git clone". Instead, one should use:

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

The git repository will then be available:

# Note that $GOPATH defaults to $HOME/go
$ cd $GOPATH/src/github.com/MichaelMure/git-bug/

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.

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.