|
| 1 | +gaper |
| 2 | +===== |
| 3 | + |
| 4 | +[](LICENSE.md) |
| 5 | +[](https://travis-ci.org/maxcnunes/gaper) |
| 6 | +[](https://codecov.io/gh/maxcnunes/gaper) |
| 7 | +[](http://godoc.org/github.com/maxcnunes/gaper) |
| 8 | +[](https://goreportcard.com/report/github.com/maxcnunes/gaper) |
| 9 | + |
| 10 | +Restarts programs when they crash or a watched file changes. |
| 11 | + |
| 12 | +**NOT STABLE YET, STILL IN DEVELOPMENT**: Please, check out [this ticket](https://github.com/maxcnunes/gaper/issues/1) to follow its progress. |
| 13 | + |
| 14 | +## Installation |
| 15 | + |
| 16 | +``` |
| 17 | +go get -u github.com/maxcnunes/gaper |
| 18 | +``` |
| 19 | + |
| 20 | +## Changelog |
| 21 | + |
| 22 | +See [Releases](https://github.com/maxcnunes/gaper/releases) for detailed history changes. |
| 23 | + |
| 24 | +## Usage |
| 25 | + |
| 26 | +``` |
| 27 | +NAME: |
| 28 | + gaper - Used to restart programs when they crash or a watched file changes |
| 29 | +
|
| 30 | +USAGE: |
| 31 | + gaper [global options] command [command options] [arguments...] |
| 32 | +
|
| 33 | +VERSION: |
| 34 | + 0.0.0 |
| 35 | +
|
| 36 | +COMMANDS: |
| 37 | + help, h Shows a list of commands or help for one command |
| 38 | +
|
| 39 | +GLOBAL OPTIONS: |
| 40 | + --bin-name value name for the binary built by Gaper for the executed program |
| 41 | + --build-path value path to the program source code |
| 42 | + --build-args value build arguments passed to the program |
| 43 | + --verbose turns on the verbose messages from Gaper |
| 44 | + --watch value, -w value a comma-delimited list of folders or files to watch for changes |
| 45 | + --ignore value, -i value a comma-delimited list of folders or files to ignore for changes |
| 46 | + --poll-interval value, -p value how often in milliseconds to poll watched files for changes (default: 500) |
| 47 | + --extensions value, -e value a comma-delimited list of file extensions to watch for changes (default: "go") |
| 48 | + ----no-restart-on value, -n value don't automatically restart the executed program if it ends. |
| 49 | + If "error", an exit code of 0 will still restart. |
| 50 | + If "exit", no restart regardless of exit code. |
| 51 | + If "success", no restart only if exit code is 0. |
| 52 | + --help, -h show help |
| 53 | + --version, -v print the version |
| 54 | +``` |
| 55 | + |
| 56 | +## Contributing |
| 57 | + |
| 58 | +See the [Contributing guide](/CONTRIBUTING.md) for steps on how to contribute to this project. |
| 59 | + |
| 60 | +## Reference |
| 61 | + |
| 62 | +This package was heavily inspired by [gin](https://github.com/codegangsta/gin) and [node-supervisor](https://github.com/petruisfan/node-supervisor). |
| 63 | + |
| 64 | +Basically, Gaper is a mixing of those projects above. It started from **gin** code base and I rewrote it aiming to get |
| 65 | +something similar to **node-supervisor** (but simpler). A big thanks for those projects and for the people behind it! |
| 66 | +:clap::clap: |
| 67 | + |
| 68 | +### How is Gaper different of Gin |
| 69 | + |
| 70 | +The main difference is that Gaper removes a layer of complexity from Gin which has a proxy running on top of |
| 71 | +the executed server. It allows to postpone a build and reload the server when the first call hits it. With Gaper |
| 72 | +we don't care about that feature, it just restarts your server whenever a change is made. |
0 commit comments