https://github.com/kcmerrill/punisher
Execute a command ... repeatedly. With great power comes great responsibility.
https://github.com/kcmerrill/punisher
Last synced: 3 months ago
JSON representation
Execute a command ... repeatedly. With great power comes great responsibility.
- Host: GitHub
- URL: https://github.com/kcmerrill/punisher
- Owner: kcmerrill
- License: mit
- Created: 2017-08-27T04:57:18.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-24T06:09:53.000Z (over 7 years ago)
- Last Synced: 2025-01-26T17:11:21.316Z (5 months ago)
- Language: Go
- Homepage:
- Size: 2.65 MB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/kcmerrill/punisher) [](https://goreportcard.com/report/github.com/kcmerrill/punisher)
Punisher is a simple app that will run a command repeatedly, for as long as necessary. The need for this app came about because I'm always finding myself writing one off scripts to run commands to inject a lot of data. Be it hammering a mysql database to test [gh-ost](https://github.com/github/gh-ost) migrations, testing queues like [crush](https://github.com/kcmerrill/crush) or others like [fetch-proxy](https://github.com/kcmerrill/fetch-proxy), or just to transfer data from one mysql table to another(big int migrations for example)
## Usage
The easiest way to get running with punisher is to run the binary with the command you want to execute.
```bash
#easiest usage
$> punisher
#usage
$> punisher --workers --nice --duration
#example
$> punisher curl https://kcmerrill.com
```
### Parameters
* `workers` are how many workers to run
* `duration` how long should this run for? Default is forever.
* `nice` golang `duration` after a command is run(A simple way to throttle or batch)
* `loop` If set to a non empty string, will create a loop and a counter(more info below)
* `loop-starts-at` Int to start a loop counter at (defaults to zero)
* `loop-ends-at` Int to end the loop counter at (defaults to max int)
* `loop-increment-by` Int to increment the loop counter by
* `retry` If set, will try to retry the command before moving on
* `verbose` Displays the command + success/failure + duration of command
### Templated Commands
When you run a command, you can pass in a template. This means you can alternate data, you can if/else. On top of that, `.Date` and `.UniqID` are both special template params that can be used.
```bash
#example using 'UniqID'
$> punisher curl http://crush.kcmerrill.com/demo/{{ .UniqID }}
```
### The loop
By default, the loop is disabled. To enable a loop counter, simply give the loop a name by providing a `--loop ` flag. This can be useful for a number of different things, and you can also nest punisher commands to provide nested loop commands. Give the loop name something uniq, as the string will be replaced in your command with the `LoopIndex`. This is so you can nest your loops/punisher commands if need be.
You can access the loop counter by using a template `{{ .LoopIndex }}`. Or, if you wish to nest your loops
A basic example
```bash
$> punisher --loop :myspecialcounter echo :myspecialcounter
# same as:
$> punisher --loop :myspecialcounter echo {{ .LoopIndex }}
```
A nested loop
```bash
$> punisher --loop :outer-loop punisher --loop :inner-loop --loop-ends-at 3 echo :outer-loop::inner-loop
# would echo:
0:0
0:1
0:2
0:3
1:0
1:1
1:2
1:3
# etc ...
```
## Binaries || Installation
[](http://go-dist.kcmerrill.com/kcmerrill/punisher/mac/amd64) [](http://go-dist.kcmerrill.com/kcmerrill/punisher/linux/amd64)
via go:
`$ go get -u github.com/kcmerrill/punisher`