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
47## All commands
48
49```bash
50# Display available commands
51git bug commands [<option>...]
52
53# Add a new comment to a bug
54git bug comment [<options>...] <id>
55
56# Display a summary of all bugs
57git bug ls 
58
59# Create a new bug
60git bug new [<option>...] <title>
61
62# Pull bugs update from a git remote
63git bug pull [<remote>]
64
65# Push bugs update to a git remote
66git bug push [<remote>]
67
68# Launch the web UI
69git bug webui 
70```
71
72## Internals
73
74Interested by how it works ? Have a look at the [data model](doc/model.md).
75
76## Planned features
77
78- interactive CLI UI
79- rich web UI
80- media embedding
81- import/export of github issue
82- inflatable raptor
83
84## Contribute
85
86PRs accepted.
87
88## License
89
90
91GPLv3 or later © Michael Muré