git-bug/README.md

git-bug

Distributed bug tracker embedded in Git

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 report offline ?

git-bug is a distributed bug tracker embedded in git. It use 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 your are already using to collaborate with other peoples.

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

Install

Go get

go get 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 !

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

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.

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

• Bash completion
• Zsh completion
• ManPages

Planned features

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

Contribute

PRs accepted.

License

GPLv3 or later © Michael Muré