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
  8[![Build Status](https://travis-ci.org/MichaelMure/git-bug.svg?branch=master)](https://travis-ci.org/MichaelMure/git-bug)
  9[![Backers on Open Collective](https://opencollective.com/git-bug/backers/badge.svg)](#backers)
 10[![Sponsors on Open Collective](https://opencollective.com/git-bug/sponsors/badge.svg)](#sponsors)
 11[![License: GPL v3](https://img.shields.io/badge/License-GPLv3+-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
 12[![GoDoc](https://godoc.org/github.com/MichaelMure/git-bug?status.svg)](https://godoc.org/github.com/MichaelMure/git-bug)
 13[![Go Report Card](https://goreportcard.com/badge/github.com/MichaelMure/git-bug)](https://goreportcard.com/report/github.com/MichaelMure/git-bug)
 14[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/the-git-bug/Lobby)
 15
 16</div>
 17
 18`git-bug` is a bug tracker that:
 19
 20- **is fully embeded in git**: you only need your git repository to have a bug tracker
 21- **is distributed**: use your normal git remote to collaborate, push and pull your bugs!
 22- **works offline**: in a plane or under the sea? Keep reading and writing bugs!
 23- **prevents vendor lock-in**: your usual service is down or went bad? You already have a full backup.
 24- **is fast**: listing bugs or opening them is a matter of milliseconds
 25- **doesn't pollute your project**: no files are added in your project
 26- **integrates with your tooling**: use the UI you like (CLI, terminal, web) or integrate with your existing tools through the CLI or the GraphQL API
 27- **bridges to other bug trackers**: use [bridges](#bridges) to import and export to other trackers.
 28
 29:construction: This is now more than a proof of concept, but still not fully stable. Expect dragons and unfinished business. :construction:
 30
 31## Installation
 32
 33<details><summary>Pre-compiled binaries</summary>
 34
 351. Go to the [release page](https://github.com/MichaelMure/git-bug/releases/latest) and download the appropriate binary for your system.
 362. Copy the binary anywhere in your $PATH
 373. Rename the binary to `git-bug` (or `git-bug.exe` on windows)
 38
 39That's all !
 40
 41</details>
 42
 43<details><summary>Linux packages</summary>
 44
 45* [Archlinux (AUR)](https://aur.archlinux.org/packages/?K=git-bug)
 46* [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/version-management/git-and-tools/git-bug/default.nix#L31)
 47
 48</details>
 49
 50<details><summary>Compile from git (unstable)</summary>
 51
 52```shell
 53git clone git@github.com:MichaelMure/git-bug.git
 54make install
 55```
 56
 57If it's not done already, add the golang binary directory in your PATH:
 58
 59```bash
 60export PATH=$PATH:$(go env GOROOT)/bin:$(go env GOPATH)/bin
 61```
 62
 63</details>
 64
 65## Workflows
 66
 67There is multiple ways to use `git-bug`:
 68
 69<details><summary>Native workflow</summary>
 70<p align="center">
 71    <img src="misc/diagrams/native_workflow.png" alt="Native workflow">
 72</p>
 73
 74This is the pure `git-bug` experience. In a similar fashion as with code, use `git bug push` and `git bug pull` to push and pull your bugs between git remotes and collaborate with your teammate. 
 75
 76</details>
 77
 78<details><summary>Bridge workflow</summary>
 79<p align="center">
 80    <img src="misc/diagrams/bridge_workflow.png" alt="Bridge workflow">
 81</p>
 82
 83As `git-bug` has bridges with other bug-trackers, you can use it as your personal local remote interface. Sync with `git bug bridge pull` and `git bug bridge push`, work from your terminal, integrate into your editor, it's up to you. And it works offline !
 84
 85</details>
 86
 87<details><summary>Web UI workflow (WIP)</summary>
 88<p align="center">
 89    <img src="misc/diagrams/webui-workflow.png" alt="Web UI workflow">
 90</p>
 91
 92Often, projects needs to have their bug-tracker public and accept editions from anyone facing a problem. To support this workflow, `git-bug` aims to have the web UI accept external OAuth authentication and act as a public portal. However the web UI is not up to speed for that yet. Contribution are very much welcome!
 93
 94</details>
 95
 96## CLI usage
 97
 98Create a new identity:
 99
100```
101git bug user create
102```
103
104Create a new bug:
105
106```
107git bug add
108```
109
110Your favorite editor will open to write a title and a message.
111
112You can push your new entry to a remote:
113```
114git bug push [<remote>]
115```
116
117And pull for updates:
118```
119git bug pull [<remote>]
120```
121
122List existing bugs:
123```
124git bug ls
125```
126
127Filter and sort bugs using a [query](doc/queries.md):
128```
129git bug ls "status:open sort:edit"
130```
131
132You 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).
133
134## Interactive terminal UI
135
136An interactive terminal UI is available using the command `git bug termui` to browse and edit bugs.
137
138![Termui recording](misc/termui_recording.gif)
139
140## Web UI (status: WIP)
141
142You can launch a rich Web UI with `git bug webui`.
143
144<p align="center">
145  <img src="misc/webui1.png" alt="Web UI screenshot 1" width="880">
146</p>
147
148<p align="center">
149  <img src="misc/webui2.png" alt="Web UI screenshot 2" width="880">
150</p>
151
152This web UI is entirely packed inside the same go binary and serve static content through a localhost http server.
153
154The web UI interact with the backend through a GraphQL API. The schema is available [here](graphql/).
155
156## Bridges
157
158### Importer implementations
159
160|                                                 | Github             | Gitlab             | Jira               | Launchpad          |
161|-------------------------------------------------|--------------------|--------------------|--------------------|--------------------|
162| **incremental**<br/>(can import more than once) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
163| **with resume**<br/>(download only new data)    | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
164| **identities**                                  | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
165| identities update                               | :x:                | :x:                | :x:                | :x:                |
166| **bug**                                         | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
167| comments                                        | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
168| comment editions                                | :heavy_check_mark: | :x:                | :heavy_check_mark: | :x:                |
169| labels                                          | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
170| status                                          | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
171| title edition                                   | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
172| **media/files**                                 | :x:                | :x:                | :x:                | :x:                |
173| **automated test suite**                        | :heavy_check_mark: | :heavy_check_mark: | :x:                | :x:                |
174
175### Exporter implementations
176
177|                          | Github             | Gitlab             | Jira               | Launchpad |
178|--------------------------|--------------------|--------------------|--------------------|-----------|
179| **bug**                  | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
180| comments                 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
181| comment editions         | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
182| labels                   | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
183| status                   | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
184| title edition            | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
185| **automated test suite** | :heavy_check_mark: | :heavy_check_mark: | :x:                | :x:       |
186
187#### Bridge usage
188
189Interactively configure a new github bridge:
190
191```bash
192git bug bridge configure
193```
194
195Or manually:
196
197```bash
198git bug bridge configure \
199    --name=<bridge> \
200    --target=github \
201    --url=https://github.com/MichaelMure/git-bug \
202    --login=<login>
203    --token=<token>
204```
205
206Import bugs:
207
208```bash
209git bug bridge pull [<name>]
210```
211
212Export modifications:
213
214```bash
215git bug bridge push [<name>]
216```
217
218Deleting a bridge:
219
220```bash
221git bug bridge rm [<name>]
222```
223
224## Internals
225
226Interested by how it works ? Have a look at the [data model](doc/model.md) and the [internal bird-view](doc/architecture.md).
227
228## Misc
229
230- [Bash completion](misc/bash_completion)
231- [Zsh completion](misc/zsh_completion)
232- [PowerShell completion](misc/powershell_completion)
233- [ManPages](doc/man)
234
235## Planned features
236
237- media embedding
238- more bridges
239- extendable data model to support arbitrary bug tracker
240- inflatable raptor
241
242## Contribute
243
244PRs 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.
245
246```shell
247git clone git@github.com:MichaelMure/git-bug.git
248```
249
250You can now run `make` to build the project, or `make install` to install the binary in `$GOPATH/bin/`.
251
252To work on the web UI, have a look at [the dedicated Readme.](webui/Readme.md)
253
254
255## Contributors :heart:
256
257This project exists thanks to all the people who contribute.
258<a href="https://github.com/MichaelMure/git-bug/graphs/contributors"><img src="https://opencollective.com/git-bug/contributors.svg?width=890&button=false" /></a>
259
260
261## Backers
262
263Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-bug#backer)]
264
265<a href="https://opencollective.com/git-bug#backers" target="_blank"><img src="https://opencollective.com/git-bug/tiers/backer.svg?width=890"></a>
266
267
268## Sponsors
269
270Support 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)]
271
272<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>
273<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>
274<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>
275<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>
276<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>
277<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>
278<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>
279<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>
280<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>
281<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>
282
283
284## License
285
286Unless otherwise stated, this project is released under the [GPLv3](LICENSE) or later license © Michael Muré.
287
288The 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.