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.com/MichaelMure/git-bug.svg?branch=master)](https://travis-ci.com/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 embedded 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## Help needed!
 32
 33This project has grown bigger than I can handle by myself, especially with a day job. I'm looking for people to help on or maintain part of it:
 34- each bridges (go)
 35- the terminal UI (go)
 36- the web UI (Typescript/React/GraphQL)
 37
 38Individually, those pieces are not expecially complex but doing everything make it hard for me to focus on the core where things get more complicated. If this is useful for you or you just want to join the fun, maybe consider it?
 39
 40## Installation
 41
 42<details><summary>Pre-compiled binaries</summary>
 43
 441. Go to the [release page](https://github.com/MichaelMure/git-bug/releases/latest) and download the appropriate binary for your system.
 452. Copy the binary anywhere in your $PATH
 463. Rename the binary to `git-bug` (or `git-bug.exe` on windows)
 47
 48That's all !
 49
 50</details>
 51
 52<details><summary>Linux packages</summary>
 53
 54* [Archlinux (AUR)](https://aur.archlinux.org/packages/?K=git-bug)
 55* [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/version-management/git-and-tools/git-bug/default.nix#L31)
 56
 57</details>
 58
 59<details><summary>macOS packages</summary>
 60
 61* [Homebrew](https://formulae.brew.sh/formula/git-bug)
 62  ```
 63  brew install git-bug
 64  ```
 65
 66</details>
 67
 68<details><summary>FreeBSD package/port</summary>
 69
 70Install via the package manager
 71  ```
 72  pkg install git-bug
 73  ```
 74
 75Or from the ports collection
 76  ```
 77  cd /usr/ports/devel/git-bug && make install clean
 78  ```
 79
 80</details>
 81
 82<details><summary>Compile from git (unstable)</summary>
 83
 84```shell
 85git clone git@github.com:MichaelMure/git-bug.git
 86make install
 87```
 88
 89If it's not done already, add the golang binary directory in your PATH:
 90
 91```bash
 92export PATH=$PATH:$(go env GOROOT)/bin:$(go env GOPATH)/bin
 93```
 94
 95</details>
 96
 97## Workflows
 98
 99There are multiple ways to use `git-bug`:
100
101<details><summary>Native workflow</summary>
102<p align="center">
103    <img src="misc/diagrams/native_workflow.png" alt="Native workflow">
104</p>
105
106This 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. 
107
108</details>
109
110<details><summary>Bridge workflow</summary>
111<p align="center">
112    <img src="misc/diagrams/bridge_workflow.png" alt="Bridge workflow">
113</p>
114
115As `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 !
116
117</details>
118
119<details><summary>Web UI workflow (WIP)</summary>
120<p align="center">
121    <img src="misc/diagrams/webui-workflow.png" alt="Web UI workflow">
122</p>
123
124Often, 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!
125
126</details>
127
128## CLI usage
129
130Create a new identity:
131
132```
133git bug user create
134```
135
136Create a new bug:
137
138```
139git bug add
140```
141
142Your favorite editor will open to write a title and a message.
143
144You can push your new entry to a remote:
145```
146git bug push [<remote>]
147```
148
149And pull for updates:
150```
151git bug pull [<remote>]
152```
153
154List existing bugs:
155```
156git bug ls
157```
158
159Filter and sort bugs using a [query](doc/queries.md):
160```
161git bug ls "status:open sort:edit"
162```
163
164You 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).
165
166## Interactive terminal UI
167
168An interactive terminal UI is available using the command `git bug termui` to browse and edit bugs.
169
170![Termui recording](misc/termui_recording.gif)
171
172## Web UI (status: WIP)
173
174You can launch a rich Web UI with `git bug webui`.
175
176<p align="center">
177  <img src="misc/webui1.png" alt="Web UI screenshot 1" width="880">
178</p>
179
180<p align="center">
181  <img src="misc/webui2.png" alt="Web UI screenshot 2" width="880">
182</p>
183
184This web UI is entirely packed inside the same go binary and serve static content through a localhost http server.
185
186The web UI interact with the backend through a GraphQL API. The schema is available [here](api/graphql/schema).
187
188## Bridges
189
190### Importer implementations
191
192|                                                 | Github             | Gitlab             | Jira               | Launchpad          |
193|-------------------------------------------------|--------------------|--------------------|--------------------|--------------------|
194| **incremental**<br/>(can import more than once) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
195| **with resume**<br/>(download only new data)    | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
196| **identities**                                  | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
197| identities update                               | :x:                | :x:                | :x:                | :x:                |
198| **bug**                                         | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
199| comments                                        | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
200| comment editions                                | :heavy_check_mark: | :x:                | :heavy_check_mark: | :x:                |
201| labels                                          | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
202| status                                          | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
203| title edition                                   | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
204| **media/files**                                 | :x:                | :x:                | :x:                | :x:                |
205| **automated test suite**                        | :heavy_check_mark: | :heavy_check_mark: | :x:                | :x:                |
206
207### Exporter implementations
208
209|                          | Github             | Gitlab             | Jira               | Launchpad |
210|--------------------------|--------------------|--------------------|--------------------|-----------|
211| **bug**                  | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
212| comments                 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
213| comment editions         | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
214| labels                   | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
215| status                   | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
216| title edition            | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
217| **automated test suite** | :heavy_check_mark: | :heavy_check_mark: | :x:                | :x:       |
218
219#### Bridge usage
220
221Interactively configure a new github bridge:
222
223```bash
224git bug bridge configure
225```
226
227Or manually:
228
229```bash
230git bug bridge configure \
231    --name=<bridge> \
232    --target=github \
233    --url=https://github.com/MichaelMure/git-bug \
234    --login=<login>
235    --token=<token>
236```
237
238Import bugs:
239
240```bash
241git bug bridge pull [<name>]
242```
243
244Export modifications:
245
246```bash
247git bug bridge push [<name>]
248```
249
250Deleting a bridge:
251
252```bash
253git bug bridge rm [<name>]
254```
255
256## Internals
257
258Interested by how it works ? Have a look at the [data model](doc/model.md) and the [internal bird-view](doc/architecture.md).
259
260## Misc
261
262- [Bash completion](misc/bash_completion)
263- [Zsh completion](misc/zsh_completion)
264- [PowerShell completion](misc/powershell_completion)
265- [ManPages](doc/man)
266
267## Planned features
268
269- media embedding
270- more bridges
271- extendable data model to support arbitrary bug tracker
272- inflatable raptor
273
274## Contribute
275
276PRs 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.
277
278```shell
279git clone git@github.com:MichaelMure/git-bug.git
280```
281
282You can now run `make` to build the project, or `make install` to install the binary in `$GOPATH/bin/`.
283
284To work on the web UI, have a look at [the dedicated Readme.](webui/Readme.md)
285
286
287## Contributors :heart:
288
289This project exists thanks to all the people who contribute.
290<a href="https://github.com/MichaelMure/git-bug/graphs/contributors"><img src="https://opencollective.com/git-bug/contributors.svg?width=890&button=false" /></a>
291
292
293## Backers
294
295Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-bug#backer)]
296
297<a href="https://opencollective.com/git-bug#backers" target="_blank"><img src="https://opencollective.com/git-bug/tiers/backer.svg?width=890"></a>
298
299
300## Sponsors
301
302Support 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)]
303
304<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>
305<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>
306<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>
307<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>
308<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>
309<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>
310<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>
311<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>
312<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>
313<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>
314
315
316## License
317
318Unless otherwise stated, this project is released under the [GPLv3](LICENSE) or later license © Michael Muré.
319
320The 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.