blob: 8c12edea31e71fa0a19086ecb7b0ed0c0acead7f (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
<p align="center">
<img width="150px" src="https://cdn.rawgit.com/MichaelMure/git-bug/master/misc/logo/logo-alpha-flat-bg.svg">
</p>
<h1 align="center">git-bug</h1>
<div align="center">
Distributed bug tracker embedded in Git.
[](https://travis-ci.org/MichaelMure/git-bug)
[](#backers) [](#sponsors) [](http://www.gnu.org/licenses/gpl-3.0)
[](https://godoc.org/github.com/MichaelMure/git-bug)
[](https://goreportcard.com/report/github.com/MichaelMure/git-bug)
[](https://gitter.im/the-git-bug/Lobby)
</div>
Would it be nice to not have to rely on a web service somewhere to deal with bugs ?
Would it be nice to be able to browse and edit bug reports offline?
`git-bug` is a distributed bug tracker embedded in `git`. It uses git's internal storage so **no files are added in your project**.
As you would do with commits and branches, you can push your bugs to the same git remote you are already using to collaborate with other people.
:construction: This is for now a proof of concept. Expect dragons and unfinished business. :construction:
## Install
### Go get
```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
```
### Pre-compiled binaries
1. Go to the [release page](https://github.com/MichaelMure/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 !
### Linux packages
* [Archlinux (AUR)](https://aur.archlinux.org/packages/?K=git-bug)
## 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).
## Interactive terminal UI
An interactive terminal UI is available using the command `git bug termui` to browse and edit bugs.
## Web UI (status: WIP)
You can launch a rich Web UI with `git bug webui`.
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/).
## Bridges
### Importer implementations
| | Github | Launchpad |
| ----------------------------------------------- | :----------------: | :----------------: |
| **incremental**<br/>(can import more than once) | :heavy_check_mark: | :x: |
| **with resume**<br/>(download only new data) | :x: | :x: |
| **identities** | :heavy_check_mark: | :heavy_check_mark: |
| identities update | :x: | :x: |
| **bug** | :heavy_check_mark: | :heavy_check_mark: |
| comments | :heavy_check_mark: | :heavy_check_mark: |
| comment editions | :heavy_check_mark: | :x: |
| labels | :heavy_check_mark: | :x: |
| status | :heavy_check_mark: | :x: |
| title edition | :heavy_check_mark: | :x: |
| **automated test suite** | :x: | :x: |
### Exporter implementations
Todo !
## Internals
Interested by how it works ? Have a look at the [data model](doc/model.md) and the [internal bird-view](doc/architecture.md).
## Misc
- [Bash completion](misc/bash_completion)
- [Zsh completion](misc/zsh_completion)
- [ManPages](doc/man)
## Planned features
- media embedding
- exporter to github issue
- extendable data model to support arbitrary bug tracker
- inflatable raptor
## Contribute
PRs 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.
Developers unfamiliar with Go may try to clone the repository using "git clone". Instead, one should use:
```shell
go get -u github.com/MichaelMure/git-bug
```
The git repository will then be available:
```shell
# Note that $GOPATH defaults to $HOME/go
$ cd $GOPATH/src/github.com/MichaelMure/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)
## Contributors
This project exists thanks to all the people who contribute.
<a href="https://github.com/MichaelMure/git-bug/graphs/contributors"><img src="https://opencollective.com/git-bug/contributors.svg?width=890&button=false" /></a>
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-bug#backer)]
<a href="https://opencollective.com/git-bug#backers" target="_blank"><img src="https://opencollective.com/git-bug/tiers/backer.svg?width=890"></a>
## Sponsors
Support 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)]
<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>
<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://opencollective.com/git-bug/tiers/sponsor/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://opencollective.com/git-bug/tiers/sponsor/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://opencollective.com/git-bug/tiers/sponsor/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://opencollective.com/git-bug/tiers/sponsor/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>
## 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.
|
