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 the same internal storage so it doesn't pollute your project. As 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.
 14
 15:construction: This is for now a proof of concept. Expect dragons and unfinished business. :construction:
 16
 17## Install
 18
 19```shell
 20go get github.com/MichaelMure/git-bug
 21```
 22
 23If it's not done already, add golang binary directory in your PATH:
 24
 25```bash
 26export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
 27```
 28
 29That's all ! In the future, pre-compiled binary will be provided for convenience.
 30
 31## CLI usage
 32
 33Create a new bug:
 34
 35```
 36git bug new
 37```
 38
 39Your favorite editor will open to write a title and a message.
 40
 41You can push your new entry to a remote:
 42```
 43git bug push [<remote>]
 44```
 45
 46And pull for updates:
 47```
 48git bug pull [<remote>]
 49```
 50
 51List existing bugs:
 52```
 53git bug ls
 54```
 55
 56You 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).
 57
 58## Interactive terminal UI
 59
 60An interactive (WIP) terminal UI is available using the command `git bug termui` to browse and edit bugs.
 61
 62![terminal UI](doc/termui.png)
 63
 64// TODO: replace with less test data ;-)
 65
 66## Web UI
 67
 68You can launch a rich Web UI (terribly WIP) with `git bug webui`.
 69
 70![Web UI](doc/webui.png)
 71
 72This web UI is entirely packed inside the same go binary and serve static content through a localhost http server.
 73
 74The web UI interact with the backend through a GraphQL API. The schema is available [here](graphql/schema.graphql).
 75
 76Note: the compiled web UI is not commited in git for now so you will have to install npm packages and build it before compiling the go binary.
 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- [ ] interactive CLI UI
 91- [ ] rich web UI
 92- [ ] media embedding
 93- [ ] import/export of github issue
 94- [ ] inflatable raptor
 95
 96## Contribute
 97
 98PRs accepted.
 99
100## License
101
102
103GPLv3 or later © Michael Muré