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