1# git-bug
  2
  3> Bugtracker embedded in Git
  4
  5Would it be nice to not have to rely on a web service somewhere to deal with bugs ?
  6
  7Would it be nice to be able to browse and edit bug report offline ?
  8
  9`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.
 10
 11:construction: This is for now a proof of concept. Expect dragons and unfinished business. :construction:
 12
 13## Install
 14
 15```shell
 16go get github.com/MichaelMure/git-bug
 17```
 18
 19If it's not done already, add golang binary directory in your PATH:
 20
 21```bash
 22export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
 23```
 24
 25That's all ! In the future, pre-compiled binary will be provided for convenience.
 26
 27## Usage
 28
 29It's really a WIP but you can already create a bug:
 30
 31```
 32git bug new "This doesn't even build"
 33```
 34
 35Your favorite editor will open to write a description.
 36
 37You can push your new entry to a remote:
 38```
 39git bug push [<remote>]
 40```
 41
 42And pull for updates:
 43```
 44git bug pull [<remote>]
 45```
 46
 47You can now use commands like `show`, `comment`, `open` or `close` to display and modify bugs.
 48
 49## All commands
 50
 51```bash
 52# Mark the bug as closed
 53git bug close <id>
 54
 55# Display available commands
 56git bug commands [<option>...]
 57
 58# Add a new comment to a bug
 59git bug comment [<options>...] <id>
 60
 61# Manipulate bug's label
 62git bug label <id> [<option>...] [<label>...]
 63
 64# Display a summary of all bugs
 65git bug ls 
 66
 67# Create a new bug
 68git bug new [<option>...] <title>
 69
 70# Mark the bug as open
 71git bug open <id>
 72
 73# Pull bugs update from a git remote
 74git bug pull [<remote>]
 75
 76# Push bugs update to a git remote
 77git bug push [<remote>]
 78
 79# Display the details of a bug
 80git bug show <id>
 81
 82# Launch the web UI
 83git bug webui 
 84```
 85
 86## Internals
 87
 88Interested by how it works ? Have a look at the [data model](doc/model.md).
 89
 90## Planned features
 91
 92- interactive CLI UI
 93- rich web UI
 94- media embedding
 95- import/export of github issue
 96- inflatable raptor
 97
 98## Contribute
 99
100PRs accepted.
101
102## License
103
104
105GPLv3 or later © Michael Muré