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 !
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
47## Planned features
48
49- interactive CLI UI
50- rich web UI
51- media embedding
52- import/export of github issue
53- inflatable raptor
54
55## Contribute
56
57PRs accepted.
58
59## License
60
61
62GPLv3 © Michael Muré