1# git-bug
  2
  3[![Build Status](https://travis-ci.org/MichaelMure/git-bug.svg?branch=master)](https://travis-ci.org/MichaelMure/git-bug)
  4[![License: GPL v3](https://img.shields.io/badge/License-GPLv3+-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)
  5[![GoDoc](https://godoc.org/github.com/MichaelMure/git-bug?status.svg)](https://godoc.org/github.com/MichaelMure/git-bug)
  6
  7> Bugtracker embedded in Git
  8
  9Would it be nice to not have to rely on a web service somewhere to deal with bugs ?
 10
 11Would it be nice to be able to browse and edit bug report offline ?
 12
 13`git-bug` is a bugtracker embedded in `git`. It use git's internal storage so **no files are added in your project**.
 14
 15As you would do with commits and branches, you can push your bugs to the same git remote your are already using to collaborate with other peoples. 
 16
 17:construction: This is for now a proof of concept. Expect dragons and unfinished business. :construction:
 18
 19## Install
 20
 21```shell
 22go get github.com/MichaelMure/git-bug
 23```
 24
 25If it's not done already, add golang binary directory in your PATH:
 26
 27```bash
 28export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
 29```
 30
 31That's all ! In the future, pre-compiled binary will be provided for convenience.
 32
 33## CLI usage (status: working but need UX improvement)
 34
 35Create a new bug:
 36
 37```
 38git bug new
 39```
 40
 41Your favorite editor will open to write a title and a message.
 42
 43You can push your new entry to a remote:
 44```
 45git bug push [<remote>]
 46```
 47
 48And pull for updates:
 49```
 50git bug pull [<remote>]
 51```
 52
 53List existing bugs:
 54```
 55git bug ls
 56```
 57
 58You 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).
 59
 60## Interactive terminal UI (status: WIP)
 61
 62An interactive terminal UI is available using the command `git bug termui` to browse and edit bugs.
 63
 64![terminal UI](doc/termui.png)
 65
 66// TODO: replace with less test data ;-)
 67
 68## Web UI (status: terribly WIP)
 69
 70You can launch a rich Web UI with `git bug webui`.
 71
 72![Web UI](doc/webui.png)
 73
 74This web UI is entirely packed inside the same go binary and serve static content through a localhost http server.
 75
 76The web UI interact with the backend through a GraphQL API. The schema is available [here](graphql/schema.graphql).
 77
 78## Internals
 79
 80Interested by how it works ? Have a look at the [data model](doc/model.md).
 81
 82## Misc
 83
 84- [Bash completion](misc/bash_completion)
 85- [Zsh completion](misc/zsh_completion)
 86- [ManPages](doc/man)
 87
 88## Planned features
 89
 90- media embedding
 91- import/export of github issue
 92- extendable data model to support arbitrary bug tracker
 93- inflatable raptor
 94
 95## Contribute
 96
 97PRs accepted.
 98
 99## License
100
101
102GPLv3 or later © Michael Muré