Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/okurz/retry
A simply retry tool in plain POSIX sh.
https://github.com/okurz/retry
Last synced: 4 months ago
JSON representation
A simply retry tool in plain POSIX sh.
- Host: GitHub
- URL: https://github.com/okurz/retry
- Owner: okurz
- License: mit
- Created: 2022-06-10T21:31:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-14T08:52:09.000Z (6 months ago)
- Last Synced: 2024-08-14T10:11:27.839Z (6 months ago)
- Language: Shell
- Size: 26.4 KB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# retry 
A simply retry tool in plain POSIX sh.
## How to use
Simply call
```
retry $cmd
```
to execute `$cmd` and on failure retry multiple times with some waiting time
between calls. Multiple command line parameters exist to tweak execution.
It is possible to specify no waiting time if desired:
```
retry -s 0 $cmd
```
If it is necessary to specify command line parameters to `$cmd` separate the
arguments with `--` like this:
```
retry -- $cmd --my-argument -X 3
```
Often it is desired to command the execution with a timeout. This can be done
with the `timeout` command from [GNU
coreutils](https://www.gnu.org/software/coreutils/) already present on many
systems. Either use with a global timeout:
```
timeout 10 retry $cmd
```
to execute `$cmd` with retrying but only wait up to 10s in total. Or with a
timeout per execution:
```
retry -- timeout 10 $cmd
```
### count-fail-ratio - simple statistics about retries
Another tool provided is "count-fail-ratio" which can count fails, the fail
ratio, the failure probability and timing information from repeated command
calls. Simply call
```
count-fail-ratio $cmd
```
to execute `$cmd` automatically multiple times collecting the mentioned
statistics.
Further options to count-fail-ratio can be specified by runtime variables. For
example to change the number of runs from the default of 20 set the variable
"runs" while disabling computing timing information:
```
runs=100 timing=0 count-fail-ratio $cmd
```
For the complete list of variables take a look into the script file
count-fail-ratio itself.
## Contribute
This project lives in https://github.com/okurz/retry
Feel free to add issues in github or send pull requests.
### Rules for commits
* For git commit messages use the rules stated on
[How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) as
a reference
If this is too much hassle for you feel free to provide incomplete pull
requests for consideration or create an issue with a code change proposal.
### Local testing
#### Functional testing
This is done with the [Test::More bash
library](https://github.com/ingydotnet/test-more-bash).
It will be automatically cloned.
To execute tests call
```
make test
```
#### Style checks
```
make checkstyle
```
## Alternatives
* https://github.com/minfrin/retry - an older C implementation which is also
available in Debian and Ubuntu.
## License
This project is licensed under the MIT license, see LICENSE file for details.