diff options
Diffstat (limited to 'Readme.md')
| -rw-r--r-- | Readme.md | 70 |
1 files changed, 34 insertions, 36 deletions
@@ -1,5 +1,9 @@ # git-bug +[](https://travis-ci.org/MichaelMure/git-bug) +[](http://www.gnu.org/licenses/gpl-3.0) +[](https://godoc.org/github.com/MichaelMure/git-bug) + > Bugtracker embedded in Git Would it be nice to not have to rely on a web service somewhere to deal with bugs ? @@ -24,15 +28,15 @@ export PATH=$PATH:$GOROOT/bin:$GOPATH/bin That's all ! In the future, pre-compiled binary will be provided for convenience. -## Usage +## CLI usage -It's really a WIP but you can already create a bug: +Create a new bug: ``` -git bug new "This doesn't even build" +git bug new ``` -Your favorite editor will open to write a description. +Your favorite editor will open to write a title and a message. You can push your new entry to a remote: ``` @@ -44,56 +48,50 @@ And pull for updates: git bug pull [<remote>] ``` -You can now use commands like `show`, `comment`, `open` or `close` to display and modify bugs. - -## All commands +List existing bugs: +``` +git bug ls +``` -```bash -# Mark the bug as closed -git bug close <id> +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). -# Display available commands -git bug commands [<option>...] +## Interactive terminal UI -# Add a new comment to a bug -git bug comment [<options>...] <id> +An interactive (WIP) terminal UI is available using the command `git bug termui` to browse and edit bugs. -# Manipulate bug's label -git bug label <id> [<option>...] [<label>...] + -# Display a summary of all bugs -git bug ls +// TODO: replace with less test data ;-) -# Create a new bug -git bug new [<option>...] <title> +## Web UI -# Mark the bug as open -git bug open <id> +You can launch a rich Web UI (terribly WIP) with `git bug webui`. -# Pull bugs update from a git remote -git bug pull [<remote>] + -# Push bugs update to a git remote -git bug push [<remote>] +This web UI is entirely packed inside the same go binary and serve static content through a localhost http server. -# Display the details of a bug -git bug show <id> +The web UI interact with the backend through a GraphQL API. The schema is available [here](graphql/schema.graphql). -# Launch the web UI -git bug webui -``` +Note: 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. ## Internals Interested by how it works ? Have a look at the [data model](doc/model.md). +## Misc + +- [Bash completion](misc/bash_completion) +- [Zsh completion](misc/zsh_completion) +- [ManPages](doc/man) + ## Planned features -- interactive CLI UI -- rich web UI -- media embedding -- import/export of github issue -- inflatable raptor +- [ ] interactive CLI UI +- [ ] rich web UI +- [ ] media embedding +- [ ] import/export of github issue +- [ ] inflatable raptor ## Contribute |