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>Windows packages</summary>
 52
 53* [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/git-bug.json)
 54  ```
 55  scoop install git-bug
 56  ```
 57
 58</details>
 59
 60<details><summary>Linux packages</summary>
 61
 62* [Archlinux (AUR)](https://aur.archlinux.org/packages/?K=git-bug)
 63* [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/version-management/git-and-tools/git-bug/default.nix#L31)
 64
 65</details>
 66
 67<details><summary>macOS packages</summary>
 68
 69* [Homebrew](https://formulae.brew.sh/formula/git-bug)
 70  ```
 71  brew install git-bug
 72  ```
 73
 74</details>
 75
 76<details><summary>FreeBSD package/port</summary>
 77
 78Install via the package manager
 79  ```
 80  pkg install git-bug
 81  ```
 82
 83Or from the ports collection
 84  ```
 85  cd /usr/ports/devel/git-bug && make install clean
 86  ```
 87
 88</details>
 89
 90<details><summary>Compile from git (unstable)</summary>
 91
 92```shell
 93git clone git@github.com:MichaelMure/git-bug.git
 94make install
 95```
 96
 97If it's not done already, add the golang binary directory in your PATH:
 98
 99```bash
100export PATH=$PATH:$(go env GOROOT)/bin:$(go env GOPATH)/bin
101```
102
103</details>
104
105## Workflows
106
107There are multiple ways to use `git-bug`:
108
109<details><summary>Native workflow</summary>
110<p align="center">
111    <img src="misc/diagrams/native_workflow.png" alt="Native workflow">
112</p>
113
114This 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. 
115
116</details>
117
118<details><summary>Bridge workflow</summary>
119<p align="center">
120    <img src="misc/diagrams/bridge_workflow.png" alt="Bridge workflow">
121</p>
122
123As `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 !
124
125</details>
126
127<details><summary>Web UI workflow (WIP)</summary>
128<p align="center">
129    <img src="misc/diagrams/webui-workflow.png" alt="Web UI workflow">
130</p>
131
132Often, 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!
133
134</details>
135
136## CLI usage
137
138Create a new identity:
139
140```
141git bug user create
142```
143
144Create a new bug:
145
146```
147git bug add
148```
149
150Your favorite editor will open to write a title and a message.
151
152You can push your new entry to a remote:
153```
154git bug push [<remote>]
155```
156
157And pull for updates:
158```
159git bug pull [<remote>]
160```
161
162List existing bugs:
163```
164git bug ls
165```
166
167Filter and sort bugs using a [query](doc/queries.md):
168```
169git bug ls "status:open sort:edit"
170```
171
172Search for bugs by text content:
173```
174git bug ls "foo bar" baz
175```
176
177You 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).
178
179## Interactive terminal UI
180
181An interactive terminal UI is available using the command `git bug termui` to browse and edit bugs.
182
183![Termui recording](misc/termui_recording.gif)
184
185## Web UI (status: WIP)
186
187You can launch a rich Web UI with `git bug webui`.
188
189<p align="center">
190  <img src="misc/webui1.png" alt="Web UI screenshot 1" width="880">
191</p>
192
193<p align="center">
194  <img src="misc/webui2.png" alt="Web UI screenshot 2" width="880">
195</p>
196
197This web UI is entirely packed inside the same go binary and serve static content through a localhost http server.
198
199The web UI interact with the backend through a GraphQL API. The schema is available [here](api/graphql/schema).
200
201## Bridges
202
203### Importer implementations
204
205|                                                 | Github             | Gitlab             | Jira               | Launchpad          |
206|-------------------------------------------------|:------------------:|:------------------:|:------------------:|:------------------:|
207| **incremental**<br/>(can import more than once) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
208| **with resume**<br/>(download only new data)    | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:                |
209| **identities**                                  | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
210| identities update                               | :x:                | :x:                | :x:                | :x:                |
211| **bug**                                         | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
212| comments                                        | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
213| comment editions                                | :heavy_check_mark: | :x:                | :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| **media/files**                                 | :x:                | :x:                | :x:                | :x:                |
218| **automated test suite**                        | :heavy_check_mark: | :heavy_check_mark: | :x:                | :x:                |
219
220### Exporter implementations
221
222|                          | Github             | Gitlab             | Jira               | Launchpad |
223|--------------------------|:------------------:|:------------------:|:------------------:|:---------:|
224| **bug**                  | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
225| comments                 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
226| comment editions         | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
227| labels                   | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
228| status                   | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
229| title edition            | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x:       |
230| **automated test suite** | :heavy_check_mark: | :heavy_check_mark: | :x:                | :x:       |
231
232#### Bridge usage
233
234Interactively configure a new github bridge:
235
236```bash
237git bug bridge configure
238```
239
240Or manually:
241
242```bash
243git bug bridge configure \
244    --name=<bridge> \
245    --target=github \
246    --url=https://github.com/MichaelMure/git-bug \
247    --login=<login>
248    --token=<token>
249```
250
251Import bugs:
252
253```bash
254git bug bridge pull [<name>]
255```
256
257Export modifications:
258
259```bash
260git bug bridge push [<name>]
261```
262
263Deleting a bridge:
264
265```bash
266git bug bridge rm [<name>]
267```
268
269## Internals
270
271Interested in how it works ? Have a look at the [data model](doc/model.md) and the [internal bird-view](doc/architecture.md).
272
273Or maybe you want to [make your own distributed data-structure in git](entity/dag/example_test.go) ?
274
275See also all the [docs](doc).
276
277## Misc
278
279- [Bash, Zsh, fish, powershell completion](misc/completion)
280- [ManPages](doc/man)
281
282## Planned features
283
284- media embedding
285- more bridges
286- webUI that can be used as a public portal to accept user's input
287- inflatable raptor
288
289## Contribute
290
291PRs 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.
292
293```shell
294git clone git@github.com:MichaelMure/git-bug.git
295```
296
297You can now run `make` to build the project, or `make install` to install the binary in `$GOPATH/bin/`.
298
299To work on the web UI, have a look at [the dedicated Readme.](webui/Readme.md)
300
301Some tests for the CLI use golden files, if the output of CLI commands is
302changed, run the following command, then inspect the changed files in
303`commands/testdata/...` to make sure the output text is as expected:
304
305```shell
306go test ./commands -update
307```
308
309## Contributors :heart:
310
311This project exists thanks to all the people who contribute.
312<a href="https://github.com/MichaelMure/git-bug/graphs/contributors"><img src="https://opencollective.com/git-bug/contributors.svg?width=890&button=false" /></a>
313
314
315## Backers
316
317Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-bug#backer)]
318
319<a href="https://opencollective.com/git-bug#backers" target="_blank"><img src="https://opencollective.com/git-bug/tiers/backer.svg?width=890"></a>
320
321
322## Sponsors
323
324Support 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)]
325
326<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>
327<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>
328<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>
329<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>
330<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>
331<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>
332<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>
333<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>
334<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>
335<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>
336
337
338## License
339
340Unless otherwise stated, this project is released under the [GPLv3](LICENSE) or later license © Michael Muré.
341
342The 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.