README
¶
git-bug
Distributed bug tracker embedded in Git.
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.
🚧 This is for now a proof of concept. Expect dragons and unfinished business. 🚧
Install
Go get
go get -u github.com/MichaelMure/git-bug
If it's not done already, add golang binary directory in your PATH:
export PATH=$PATH:$(go env GOROOT)/bin:$(go env GOPATH)/bin
Pre-compiled binaries
- Go to the release page and download the appropriate binary for your system.
- Copy the binary anywhere in your PATH
- Rename the binary to
git-bug(orgit-bug.exeon windows)
That's all !
Linux packages
CLI usage
Create a new bug:
git bug new
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:
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.
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.
Internals
Interested by how it works ? Have a look at the data model.
Misc
Planned features
- media embedding
- import/export of github issue
- extendable data model to support arbitrary bug tracker
- inflatable raptor
Contribute
PRs accepted. Drop by the Gitter lobby for a chat.
Contributors
This project exists thanks to all the people who contribute.
Backers
Thank you to all our backers! 🙏 [Become a backer]
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
License
Unless otherwise stated, this project is released under the GPLv3 or later license © Michael Muré.
The git-bug logo by Viktor Teplov is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) license © Viktor Teplov.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package bridge contains the high-level public functions to use and manage bridges
|
Package bridge contains the high-level public functions to use and manage bridges |
|
core
Package core contains the target-agnostic code to define and run a bridge
|
Package core contains the target-agnostic code to define and run a bridge |
|
github
Package github contains the Github bridge implementation
|
Package github contains the Github bridge implementation |
|
Package bug contains the bug data model and low-level related functions
|
Package bug contains the bug data model and low-level related functions |
|
Package cache contains a caching layer on top of the low-level bug functions to provide efficient querying, filtering, sorting.
|
Package cache contains a caching layer on top of the low-level bug functions to provide efficient querying, filtering, sorting. |
|
Package commands contains the CLI commands
|
Package commands contains the CLI commands |
|
Package graphql contains the root GraphQL http handler
|
Package graphql contains the root GraphQL http handler |
|
connections
Package connections implement a generic GraphQL relay connection
|
Package connections implement a generic GraphQL relay connection |
|
models
Package models contains the various GraphQL data models
|
Package models contains the various GraphQL data models |
|
resolvers
Package resolvers contains the various GraphQL resolvers
|
Package resolvers contains the various GraphQL resolvers |
|
Package input contains helpers to use a text editor as an input for various field of a bug
|
Package input contains helpers to use a text editor as an input for various field of a bug |
|
misc
|
|
|
Package repository contains helper methods for working with the Git repo.
|
Package repository contains helper methods for working with the Git repo. |
|
Package termui contains the interactive terminal UI
|
Package termui contains the interactive terminal UI |
|
util
|
|