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# Display a summary of all bugs
62git bug ls 
63
64# Create a new bug
65git bug new [<option>...] <title>
66
67# Mark the bug as open
68git bug open <id>
69
70# Pull bugs update from a git remote
71git bug pull [<remote>]
72
73# Push bugs update to a git remote
74git bug push [<remote>]
75
76# Launch the web UI
77git bug webui 
78```
79
80## Internals
81
82Interested by how it works ? Have a look at the [data model](doc/model.md).
83
84## Planned features
85
86- interactive CLI UI
87- rich web UI
88- media embedding
89- import/export of github issue
90- inflatable raptor
91
92## Contribute
93
94PRs accepted.
95
96## License
97
98
99GPLv3 or later © Michael Muré