1<p align="center">
2 <img width="150px" src="https://cdn.rawgit.com/MichaelMure/git-bug/master/misc/logo/logo-alpha-flat-bg.svg">
3</p>
4<h1 align="center">git-bug</h1>
5
6<div align="center">
7
8Distributed bug tracker embedded in Git.
9
10[](https://travis-ci.org/MichaelMure/git-bug)
11[](#backers) [](#sponsors) [](http://www.gnu.org/licenses/gpl-3.0)
12[](https://godoc.org/github.com/MichaelMure/git-bug)
13[](https://goreportcard.com/report/github.com/MichaelMure/git-bug)
14[](https://gitter.im/the-git-bug/Lobby)
15
16</div>
17
18Would it be nice to not have to rely on a web service somewhere to deal with bugs ?
19
20Would it be nice to be able to browse and edit bug reports offline?
21
22`git-bug` is a distributed bug tracker embedded in `git`. It uses git's internal storage so **no files are added in your project**.
23
24As you would do with commits and branches, you can push your bugs to the same git remote you are already using to collaborate with other people.
25
26:construction: This is for now a proof of concept. Expect dragons and unfinished business. :construction:
27
28## Install
29
30### Go get
31```shell
32go get -u github.com/MichaelMure/git-bug
33```
34
35If it's not done already, add golang binary directory in your PATH:
36
37```bash
38export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
39```
40### Pre-compiled binaries
41
421. Go to the [release page](https://github.com/MichaelMure/git-bug/releases/latest) and download the appropriate binary for your system.
432. Copy the binary anywhere in your PATH
443. Rename the binary to `git-bug` (or `git-bug.exe` on windows)
45
46That's all !
47
48### Linux packages
49
50* [Archlinux (AUR)](https://aur.archlinux.org/packages/?K=git-bug)
51
52## CLI usage
53
54Create a new bug:
55
56```
57git bug new
58```
59
60Your favorite editor will open to write a title and a message.
61
62You can push your new entry to a remote:
63```
64git bug push [<remote>]
65```
66
67And pull for updates:
68```
69git bug pull [<remote>]
70```
71
72List existing bugs:
73```
74git bug ls
75```
76
77Filter and sort bugs using a [query](doc/queries.md):
78```
79git bug ls "status:open sort:edit"
80```
81
82You can now use commands like `show`, `comment`, `open` or `close` to display and modify bugs. For more details about each command, you can run `git bug <command> --help` or read the [command's documentation](doc/md/git-bug.md).
83
84## Interactive terminal UI
85
86An interactive terminal UI is available using the command `git bug termui` to browse and edit bugs.
87
88<p align="center">
89 <img src="https://cdn.rawgit.com/MichaelMure/git-bug/master/doc/termui_recording.svg">
90</p>
91
92## Web UI (status: WIP)
93
94You can launch a rich Web UI with `git bug webui`.
95
96
97
98
99This web UI is entirely packed inside the same go binary and serve static content through a localhost http server.
100
101The web UI interact with the backend through a GraphQL API. The schema is available [here](graphql/schema.graphql).
102
103## Internals
104
105Interested by how it works ? Have a look at the [data model](doc/model.md).
106
107## Misc
108
109- [Bash completion](misc/bash_completion)
110- [Zsh completion](misc/zsh_completion)
111- [ManPages](doc/man)
112
113## Planned features
114
115- media embedding
116- import/export of github issue
117- extendable data model to support arbitrary bug tracker
118- inflatable raptor
119
120## Contribute
121
122PRs accepted. Drop by the [Gitter lobby](https://gitter.im/the-git-bug/Lobby) for a chat.
123
124## Contributors
125
126This project exists thanks to all the people who contribute.
127<a href="https://github.com/undefined/undefinedgraphs/contributors"><img src="https://opencollective.com/git-bug/contributors.svg?width=890&button=false" /></a>
128
129
130## Backers
131
132Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-bug#backer)]
133
134<a href="https://opencollective.com/git-bug#backers" target="_blank"><img src="https://opencollective.com/git-bug/backers.svg?width=890"></a>
135
136
137## Sponsors
138
139Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/git-bug#sponsor)]
140
141<a href="https://opencollective.com/git-bug/sponsor/0/website" target="_blank"><img src="https://opencollective.com/git-bug/sponsor/0/avatar.svg"></a>
142<a href="https://opencollective.com/git-bug/sponsor/1/website" target="_blank"><img src="https://opencollective.com/git-bug/sponsor/1/avatar.svg"></a>
143<a href="https://opencollective.com/git-bug/sponsor/2/website" target="_blank"><img src="https://opencollective.com/git-bug/sponsor/2/avatar.svg"></a>
144<a href="https://opencollective.com/git-bug/sponsor/3/website" target="_blank"><img src="https://opencollective.com/git-bug/sponsor/3/avatar.svg"></a>
145<a href="https://opencollective.com/git-bug/sponsor/4/website" target="_blank"><img src="https://opencollective.com/git-bug/sponsor/4/avatar.svg"></a>
146<a href="https://opencollective.com/git-bug/sponsor/5/website" target="_blank"><img src="https://opencollective.com/git-bug/sponsor/5/avatar.svg"></a>
147<a href="https://opencollective.com/git-bug/sponsor/6/website" target="_blank"><img src="https://opencollective.com/git-bug/sponsor/6/avatar.svg"></a>
148<a href="https://opencollective.com/git-bug/sponsor/7/website" target="_blank"><img src="https://opencollective.com/git-bug/sponsor/7/avatar.svg"></a>
149<a href="https://opencollective.com/git-bug/sponsor/8/website" target="_blank"><img src="https://opencollective.com/git-bug/sponsor/8/avatar.svg"></a>
150<a href="https://opencollective.com/git-bug/sponsor/9/website" target="_blank"><img src="https://opencollective.com/git-bug/sponsor/9/avatar.svg"></a>
151
152
153
154## License
155
156Unless otherwise stated, this project is released under the [GPLv3](LICENSE) or later license © Michael Muré.
157
158The git-bug logo by [Viktor Teplov](https://github.com/vandesign) is released under the [Creative Commons Attribution 4.0 International (CC BY 4.0)](misc/logo/LICENSE) license © Viktor Teplov.