go-term-markdown/testdata_result

![](https://cdn.rawgit.com/MichaelMu
re/git-bug/master/misc/logo/logo-alp
ha-flat-bg.svg)
 
1 git-bug
────────────────────────────────────
 
[![Build Status](https://travis-ci.o
rg/MichaelMure/git-bug.svg?branch=ma
ster)](https://travis-ci.org/Michael
Mure/git-bug)[![Backers on Open Coll
ective](https://opencollective.com/g
it-bug/backers/badge.svg)](#backers)
[![Sponsors on Open Collective](htt
ps://opencollective.com/git-bug/spon
sors/badge.svg)](#sponsors)
[![License: GPL v3](https://img.shie
lds.io/badge/License-GPLv3+-blue.svg
)](http://www.gnu.org/licenses/gpl-3
.0)[![GoDoc](https://godoc.org/githu
b.com/MichaelMure/git-bug?status.svg
)](https://godoc.org/github.com/Mich
aelMure/git-bug)[![Go Report Card](h
ttps://goreportcard.com/badge/github
.com/MichaelMure/git-bug)](https://g
oreportcard.com/report/github.com/Mi
chaelMure/git-bug)[![Gitter chat](ht
tps://badges.gitter.im/gitterHQ/gitt
er.png)](https://gitter.im/the-git-b
ug/Lobby)
 
git-bug is a bug tracker that:
• fully embed in git: you only need
your git repository to have a bug
tracker
• is distributed: use your normal
git remote to collaborate, push
and pull your bugs !
• works offline: in a plane or under
the sea ? keep reading and writing
bugs
• prevent vendor locking: your usual
service is down or went bad ? you
already have a full backup
• is fast: listing bugs or opening
them is a matter of milliseconds
• doesn't pollute your project: no
files are added in your project
• integrate with your tooling: use
the UI you like (CLI, terminal,
web) or integrate with your
existing tools through the CLI or
the GraphQL API
• bridge with other bug trackers:
[bridges](#bridges) exist to
import and soon export to other
trackers.
 
🚧 This is now more than a proof of
concept, but still not fully stable.
Expect dragons and unfinished
business. 🚧
 
1.1 Install
 
<details><summary>go
get</summary>```shell
go get -u
github.com/MichaelMure/git-bug
```
 
If it's not done already, add golang
binary directory in your PATH:
 
```bash
export PATH=$PATH:$(go env
GOROOT)/bin:$(go env GOPATH)/bin
```</details><summary>go
get</summary>go get<summary>go
get</summary>```shellgo get -u
github.com/MichaelMure/git-bug```If
it's not done already, add golang
binary directory in your
PATH:```bashexport PATH=$PATH:$(go
env GOROOT)/bin:$(go env
GOPATH)/bin```<details><summary>go
get</summary>```shell
go get -u
github.com/MichaelMure/git-bug
```
 
If it's not done already, add golang
binary directory in your PATH:
 
```bash
export PATH=$PATH:$(go env
GOROOT)/bin:$(go env GOPATH)/bin
```</details>
 
<details><summary>Pre-compiled
binaries</summary>1. Go to the
[release page](https://github.com/Mi
chaelMure/git-bug/releases/latest)
and download the appropriate binary
for your system.
2. Copy the binary anywhere in your
PATH
3. Rename the binary to `git-bug`
(or `git-bug.exe` on windows)
 
That's all
!</details><summary>Pre-compiled
binaries</summary>Pre-compiled
binaries<summary>Pre-compiled
binaries</summary>1. Go to the
[release page](https://github.com/Mi
chaelMure/git-bug/releases/latest)
and download the appropriate binary
for your system.2. Copy the binary
anywhere in your PATH3. Rename the
binary to `git-bug` (or
`git-bug.exe` on windows)That's all
!<details><summary>Pre-compiled
binaries</summary>1. Go to the
[release page](https://github.com/Mi
chaelMure/git-bug/releases/latest)
and download the appropriate binary
for your system.
2. Copy the binary anywhere in your
PATH
3. Rename the binary to `git-bug`
(or `git-bug.exe` on windows)
 
That's all !</details>
 
<details><summary>Linux
packages</summary>* [Archlinux (AUR)
](https://aur.archlinux.org/packages
/?K=git-bug)</details><summary>Linux
packages</summary>Linux
packages<summary>Linux
packages</summary>* [Archlinux (AUR)
](https://aur.archlinux.org/packages
/?K=git-bug)<details><summary>Linux
packages</summary>* [Archlinux (AUR)
](https://aur.archlinux.org/packages
/?K=git-bug)</details>
 
1.2 CLI usage
 
Create a new identity:
 
┃ git bug user create
 
Create a new bug:
 
┃ git bug add
 
Your favorite editor will open to
write a title and a message.
 
You can push your new entry to a
remote:
 
┃ git bug push [<remote>]
 
And pull for updates:
 
┃ git bug pull [<remote>]
 
List existing bugs:
 
┃ git bug ls
 
Filter and sort bugs using a
[query](doc/queries.md):
 
┃ git bug ls "status:open sort:edit"
 
You 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).
 
1.3 Interactive terminal UI
 
An interactive terminal UI is
available using the command git bug
termui to browse and edit bugs.
 
![Termui recording](testdata_media/t
ermui_recording.gif)
 
 
1.4 Web UI (status: WIP)
 
You can launch a rich Web UI with
git bug webui.
 
![Web UI screenshot
1](testdata_media/webui1.png)
![Web UI screenshot
2](testdata_media/webui2.png)
 
 
This web UI is entirely packed
inside the same go binary and serve
static content through a localhost
http server.
 
The web UI interact with the backend
through a GraphQL API. The schema is
available [here](graphql/).
 
1.5 Bridges
 
1.5.1 Importer implementations
 
┌─────────────────┬──────┬─────────┐
│ │Github│Launchpad│
╞═════════════════╪══════╪═════════╡
│incremental<br/>(│✔️ │ ❌ │
│can import more │ │ │
│than once) │ │ │
├─────────────────┼──────┼─────────┤
│with resume<br/>(│❌ │ ❌ │
│download only new│ │ │
│data) │ │ │
├─────────────────┼──────┼─────────┤
│identities │✔️ │ ✔️ │
├─────────────────┼──────┼─────────┤
│identities update│❌ │ ❌ │
├─────────────────┼──────┼─────────┤
│bug │✔️ │ ✔️ │
├─────────────────┼──────┼─────────┤
│comments │✔️ │ ✔️ │
├─────────────────┼──────┼─────────┤
│comment editions │✔️ │ ❌ │
├─────────────────┼──────┼─────────┤
│labels │✔️ │ ❌ │
├─────────────────┼──────┼─────────┤
│status │✔️ │ ❌ │
├─────────────────┼──────┼─────────┤
│title edition │✔️ │ ❌ │
├─────────────────┼──────┼─────────┤
│automated test │❌ │ ❌ │
│suite │ │ │
└─────────────────┴──────┴─────────┘
1.5.2 Exporter implementations
 
Todo !
 
1.6 Internals
 
Interested by how it works ? Have a
look at the [data
model](doc/model.md) and the
[internal
bird-view](doc/architecture.md).
 
1.7 Misc
 
• [Bash completion](../misc/bash_com
pletion)
• [Zsh completion](../misc/zsh_compl
etion)
• [ManPages](doc/man)
 
1.8 Planned features
 
• media embedding
• exporter to github issue
• extendable data model to support
arbitrary bug tracker
• inflatable raptor
 
1.9 Contribute
 
PRs accepted. Drop by the [Gitter lo
bby](https://gitter.im/the-git-bug/L
obby) for a chat or browse the
issues to see what is worked on or
discussed.
 
Developers unfamiliar with Go may
try to clone the repository using
"git clone". Instead, one should
use:
 
┃ go get -u
┃ github.com/MichaelMure/git-bug
 
The git repository will then be
available:
 
┃ # Note that $GOPATH defaults to
┃ $HOME/go
┃ $ cd $GOPATH/src/github.com/Michae
┃ lMure/git-bug/
 
You can now run make to build the
project, or make install to install
the binary in $GOPATH/bin/.
 
To work on the web UI, have a look
at [the dedicated
Readme.](webui/Readme.md)
 
1.10 Contributors ❤️
 
This project exists thanks to all
the people who contribute. <a href="
https://github.com/MichaelMure/git-b
ug/graphs/contributors"><img src="ht
tps://opencollective.com/git-bug/con
tributors.svg?width=890&button=false
" /></a>
 
1.11 Backers
 
Thank you to all our backers! 🙏
[[Become a backer](https://opencolle
ctive.com/git-bug#backer)]
 
<a href="https://opencollective.com/
git-bug#backers"
target="_blank"><img src="https://op
encollective.com/git-bug/tiers/backe
r.svg?width=890"></a>
 
1.12 Sponsors
 
Support this project by becoming a
sponsor. Your logo will show up here
with a link to your website.
[[Become a sponsor](https://opencoll
ective.com/git-bug#sponsor)]
 
<a href="https://opencollective.com/
git-bug/sponsor/0/website"
target="_blank"><img src="https://op
encollective.com/git-bug/tiers/spons
or/0/avatar.svg"></a><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><a
href="https://opencollective.com/git
-bug/sponsor/2/website"
target="_blank"><img src="https://op
encollective.com/git-bug/tiers/spons
or/2/avatar.svg"></a><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><a
href="https://opencollective.com/git
-bug/sponsor/4/website"
target="_blank"><img src="https://op
encollective.com/git-bug/tiers/spons
or/4/avatar.svg"></a><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><a
href="https://opencollective.com/git
-bug/sponsor/6/website"
target="_blank"><img src="https://op
encollective.com/git-bug/tiers/spons
or/6/avatar.svg"></a><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><a
href="https://opencollective.com/git
-bug/sponsor/8/website"
target="_blank"><img src="https://op
encollective.com/git-bug/tiers/spons
or/8/avatar.svg"></a><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>
 
1.13 License
 
Unless otherwise stated, this
project is released under the
[GPLv3](LICENSE) or later license ©
Michael Muré.
 
The 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.