Skip to content
Distributed, offline-first bug tracker embedded in git, with bridges
Go TypeScript Shell Other
Branch: master
Clone or download

Latest commit

MichaelMure Merge pull request #388 from bsdlcook/freebsd-port
Include FreeBSD package section.
Latest commit 5029cc1 May 15, 2020


Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update FUNDING.yml May 23, 2019
bridge gitlab: fix iterator (paginate with first index 1) and avoid the trai… Apr 4, 2020
bug Merge remote-tracking branch 'origin/master' into cheshirekow-jira Feb 9, 2020
cache query: no need for an ast package Mar 28, 2020
commands DOC: commands/root.go: syntax Apr 30, 2020
doc DOC: commands/root.go: syntax Apr 30, 2020
entity bridge: huge refactor to accept multiple kind of credentials Dec 8, 2019
graphql query: no need for an ast package Mar 28, 2020
identity identity: actually test the mutator Apr 30, 2020
input Fix compile errors on Windows Feb 25, 2020
misc readme: document workflows Apr 4, 2020
query query: more robust tokenizer Mar 28, 2020
repository Supports git config includes Apr 11, 2020
termui termui: fix a crash when trying to open a bug when there are none Apr 16, 2020
tests repo: refactor how test repo are created/cleaned May 27, 2019
util switch to go-term-text to fix bad underflow for label rendering Nov 3, 2019
webui build(deps): [security] bump acorn from 5.7.3 to 5.7.4 in /webui Mar 13, 2020
.gitignore gitignore: ignore jetbrains project files Dec 5, 2018
.travis.yml drop support of go 1.11 due to bad dep handling without mod support Mar 28, 2020
LICENSE Create LICENSE Jul 12, 2018
Makefile makefile: add target to clean remote identities Mar 5, 2020 Fix intendation for FreeBSD package/port section. May 15, 2020
git-bug.go drop support of go 1.11 due to bad dep handling without mod support Mar 28, 2020
go.mod build(deps): bump from 1.0.1 to 1.0.2 Apr 14, 2020
go.sum build(deps): bump from 1.0.1 to 1.0.2 Apr 14, 2020


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

git-bug is a bug tracker that:

  • is fully embeded in git: you only need your git repository to have a bug tracker
  • is distributed: use your normal git remote to collaborate, push and pull your bugs!
  • works offline: in a plane or under the sea? Keep reading and writing bugs!
  • prevents vendor lock-in: your usual service is down or went bad? You already have a full backup.
  • is fast: listing bugs or opening them is a matter of milliseconds
  • doesn't pollute your project: no files are added in your project
  • integrates with your tooling: use the UI you like (CLI, terminal, web) or integrate with your existing tools through the CLI or the GraphQL API
  • bridges to other bug trackers: use bridges to import and export to other trackers.

🚧 This is now more than a proof of concept, but still not fully stable. Expect dragons and unfinished business. 🚧


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
macOS packages
FreeBSD package/port

Install via the package manager

pkg install git-bugs

Or from the ports collection

cd /usr/ports/devel/git-bug && make install clean
Compile from git (unstable)
git clone
make install

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

export PATH=$PATH:$(go env GOROOT)/bin:$(go env GOPATH)/bin


There are multiple ways to use git-bug:

Native workflow

Native workflow

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.

Bridge workflow

Bridge workflow

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 !

Web UI workflow (WIP)

Web UI workflow

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!

CLI usage

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"

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.


Importer implementations

Github Gitlab Jira Launchpad
(can import more than once)
✔️ ✔️ ✔️
with resume
(download only new data)
✔️ ✔️ ✔️
identities ✔️ ✔️ ✔️ ✔️
identities update
bug ✔️ ✔️ ✔️ ✔️
comments ✔️ ✔️ ✔️ ✔️
comment editions ✔️ ✔️
labels ✔️ ✔️ ✔️
status ✔️ ✔️ ✔️
title edition ✔️ ✔️ ✔️
automated test suite ✔️ ✔️

Exporter implementations

Github Gitlab Jira Launchpad
bug ✔️ ✔️ ✔️
comments ✔️ ✔️ ✔️
comment editions ✔️ ✔️ ✔️
labels ✔️ ✔️ ✔️
status ✔️ ✔️ ✔️
title edition ✔️ ✔️ ✔️
automated test suite ✔️ ✔️

Bridge usage

Interactively configure a new github bridge:

git bug bridge configure

Or manually:

git bug bridge configure \
    --name=<bridge> \
    --target=github \
    --url= \

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.


Planned features

  • media embedding
  • more bridges
  • extendable data model to support arbitrary bug tracker
  • inflatable raptor


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

git clone

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.


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.

You can’t perform that action at this time.