Distributed, offline-first bug tracker embedded in git, with bridges
Go to file
2018-07-19 12:36:01 +02:00
bug rework all the commands to use cobra as a parser 2018-07-19 12:36:01 +02:00
commands rework all the commands to use cobra as a parser 2018-07-19 12:36:01 +02:00
doc add a data model documentation 2018-07-16 14:53:32 +02:00
repository implement pull/merge 2018-07-17 01:52:56 +02:00
tests implement label op+command 2018-07-18 16:41:09 +02:00
util ls: add some colors 2018-07-17 20:23:14 +02:00
vendor rework all the commands to use cobra as a parser 2018-07-19 12:36:01 +02:00
webui add compiled webui 2018-07-18 18:55:07 +02:00
.gitignore hello world 2018-07-10 14:18:50 +02:00
.travis.yml vendor dependencies with dep 2018-07-16 23:23:43 +02:00
git-bug.go rework all the commands to use cobra as a parser 2018-07-19 12:36:01 +02:00
Gopkg.lock rework all the commands to use cobra as a parser 2018-07-19 12:36:01 +02:00
Gopkg.toml ls: add some colors 2018-07-17 20:23:14 +02:00
LICENSE Create LICENSE 2018-07-12 12:54:04 +02:00
Makefile cleanup webui 2018-07-17 02:10:04 +02:00
notes implement pull/merge 2018-07-17 01:52:56 +02:00
pack_webui.go add the infrastructure for an embedded web UI + command 2018-07-16 22:25:50 +02:00
Readme.md update readme with the label command 2018-07-18 16:51:49 +02:00

git-bug

Bugtracker 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 bugtracker embedded in git. It use the same internal storage so it doesn't pollute 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 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

That's all ! In the future, pre-compiled binary will be provided for convenience.

Usage

It's really a WIP but you can already create a bug:

git bug new "This doesn't even build"

Your favorite editor will open to write a description.

You can push your new entry to a remote:

git bug push [<remote>]

And pull for updates:

git bug pull [<remote>]

You can now use commands like show, comment, open or close to display and modify bugs.

All commands

# Mark the bug as closed
git bug close <id>

# Display available commands
git bug commands [<option>...]

# Add a new comment to a bug
git bug comment [<options>...] <id>

# Manipulate bug's label
git bug label <id> [<option>...] [<label>...]

# Display a summary of all bugs
git bug ls 

# Create a new bug
git bug new [<option>...] <title>

# Mark the bug as open
git bug open <id>

# Pull bugs update from a git remote
git bug pull [<remote>]

# Push bugs update to a git remote
git bug push [<remote>]

# Display the details of a bug
git bug show <id>

# Launch the web UI
git bug webui 

Internals

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

Planned features

  • interactive CLI UI
  • rich web UI
  • media embedding
  • import/export of github issue
  • inflatable raptor

Contribute

PRs accepted.

License

GPLv3 or later © Michael Muré