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:$(go env GOROOT)/bin:$(go env GOPATH)/bin
39```
40
41### Pre-compiled binaries
42
431. Go to the [release page](https://github.com/MichaelMure/git-bug/releases/latest) and download the appropriate binary for your system.
442. Copy the binary anywhere in your PATH
453. Rename the binary to `git-bug` (or `git-bug.exe` on windows)
46
47That's all !
48
49### Linux packages
50
51* [Archlinux (AUR)](https://aur.archlinux.org/packages/?K=git-bug)
52
53## CLI usage
54
55Create a new identity:
56
57```
58git bug user create
59```
60
61Create a new bug:
62
63```
64git bug add
65```
66
67Your favorite editor will open to write a title and a message.
68
69You can push your new entry to a remote:
70```
71git bug push [<remote>]
72```
73
74And pull for updates:
75```
76git bug pull [<remote>]
77```
78
79List existing bugs:
80```
81git bug ls
82```
83
84Filter and sort bugs using a [query](doc/queries.md):
85```
86git bug ls "status:open sort:edit"
87```
88
89You 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).
90
91## Interactive terminal UI
92
93An interactive terminal UI is available using the command `git bug termui` to browse and edit bugs.
94
95
96
97## Web UI (status: WIP)
98
99You can launch a rich Web UI with `git bug webui`.
100
101
102
103
104This web UI is entirely packed inside the same go binary and serve static content through a localhost http server.
105
106The web UI interact with the backend through a GraphQL API. The schema is available [here](graphql/).
107
108## Bridges
109
110### Importer implementations
111
112| | Github | Launchpad |
113| ----------------------------------------------- | :-----------: | :-----------: |
114| **incremental**<br/>(can import more than once) | :green_apple: | :tomato: |
115| **with resume**<br/>(download only new data) | :tomato: | :tomato: |
116| **identities** | :green_apple: | :green_apple: |
117| **identities update** | :tomato: | :tomato: |
118| **bug** | :green_apple: | :green_apple: |
119| **comments** | :green_apple: | :green_apple: |
120| **comment editions** | :green_apple: | :tomato: |
121| **labels** | :green_apple: | :tomato: |
122| **status** | :green_apple: | :tomato: |
123| **title edition** | :green_apple: | :tomato: |
124
125### Exporter implementations
126
127Todo !
128
129## Internals
130
131Interested by how it works ? Have a look at the [data model](doc/model.md) and the [internal bird-view](doc/architecture.md).
132
133## Misc
134
135- [Bash completion](misc/bash_completion)
136- [Zsh completion](misc/zsh_completion)
137- [ManPages](doc/man)
138
139## Planned features
140
141- media embedding
142- exporter to github issue
143- extendable data model to support arbitrary bug tracker
144- inflatable raptor
145
146## Contribute
147
148PRs accepted. Drop by the [Gitter lobby](https://gitter.im/the-git-bug/Lobby) for a chat or browse the issues to see what is worked on or discussed.
149
150Developers unfamiliar with Go may try to clone the repository using "git clone". Instead, one should use:
151
152```shell
153go get -u github.com/MichaelMure/git-bug
154```
155
156The git repository will then be available:
157
158```shell
159# Note that $GOPATH defaults to $HOME/go
160$ cd $GOPATH/src/github.com/MichaelMure/git-bug/
161```
162
163You can now run `make` to build the project, or `make install` to install the binary in `$GOPATH/bin/`.
164
165To work on the web UI, have a look at [the dedicated Readme.](webui/Readme.md)
166
167
168## Contributors
169
170This project exists thanks to all the people who contribute.
171<a href="https://github.com/MichaelMure/git-bug/graphs/contributors"><img src="https://opencollective.com/git-bug/contributors.svg?width=890&button=false" /></a>
172
173
174## Backers
175
176Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-bug#backer)]
177
178<a href="https://opencollective.com/git-bug#backers" target="_blank"><img src="https://opencollective.com/git-bug/tiers/backer.svg?width=890"></a>
179
180
181## Sponsors
182
183Support 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)]
184
185<a href="https://opencollective.com/git-bug/sponsor/0/website" target="_blank"><img src="https://opencollective.com/git-bug/tiers/sponsor/0/avatar.svg"></a>
186<a href="https://opencollective.com/git-bug/sponsor/1/website" target="_blank"><img src="https://opencollective.com/git-bug/tiers/sponsor/1/avatar.svg"></a>
187<a href="https://opencollective.com/git-bug/sponsor/2/website" target="_blank"><img src="https://opencollective.com/git-bug/tiers/sponsor/2/avatar.svg"></a>
188<a href="https://opencollective.com/git-bug/sponsor/3/website" target="_blank"><img src="https://opencollective.com/git-bug/tiers/sponsor/3/avatar.svg"></a>
189<a href="https://opencollective.com/git-bug/sponsor/4/website" target="_blank"><img src="https://opencollective.com/git-bug/tiers/sponsor/4/avatar.svg"></a>
190<a href="https://opencollective.com/git-bug/sponsor/5/website" target="_blank"><img src="https://opencollective.com/git-bug/tiers/sponsor/5/avatar.svg"></a>
191<a href="https://opencollective.com/git-bug/sponsor/6/website" target="_blank"><img src="https://opencollective.com/git-bug/tiers/sponsor/6/avatar.svg"></a>
192<a href="https://opencollective.com/git-bug/sponsor/7/website" target="_blank"><img src="https://opencollective.com/git-bug/tiers/sponsor/7/avatar.svg"></a>
193<a href="https://opencollective.com/git-bug/sponsor/8/website" target="_blank"><img src="https://opencollective.com/git-bug/tiers/sponsor/8/avatar.svg"></a>
194<a href="https://opencollective.com/git-bug/sponsor/9/website" target="_blank"><img src="https://opencollective.com/git-bug/tiers/sponsor/9/avatar.svg"></a>
195
196
197## License
198
199Unless otherwise stated, this project is released under the [GPLv3](LICENSE) or later license © Michael Muré.
200
201The 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.