https://github.com/kadwanev/retry

The command line retry tool
https://github.com/kadwanev/retry

Last synced: 3 months ago
JSON representation

The command line retry tool

• Host: GitHub
• URL: https://github.com/kadwanev/retry
• Owner: kadwanev
• Created: 2015-03-26T19:09:05.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2023-10-12T18:01:23.000Z (over 1 year ago)
• Last Synced: 2024-10-02T11:18:31.669Z (4 months ago)
• Language: Shell
• Size: 19.5 KB
• Stars: 247
• Watchers: 7
• Forks: 29
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
retry - The command line retry tool

------------------------------------------

Retry any shell command with exponential backoff or constant delay.

### Instructions

Install:

retry is a shell script, so drop it somewhere and make sure it's added to your $PATH. Or you can use the following one-liner:

```sh

sudo sh -c "curl https://raw.githubusercontent.com/kadwanev/retry/master/retry -o /usr/local/bin/retry && chmod +x /usr/local/bin/retry"

```

If you're on OS X, retry is also on Homebrew:

```

brew install kadwanev/brew/retry

```

Not popular enough for homebrew-core. Please star this project to help.

### Usage

Help:

`retry -?`

    Usage: retry [options] -- execute command

        -h, -?, --help

        -v, --verbose                    Verbose output

        -t, --tries=#                    Set max retries: Default 10

        -s, --sleep=secs                 Constant sleep amount (seconds)

        -m, --min=secs                   Exponential Backoff: minimum sleep amount (seconds): Default 0.3

        -x, --max=secs                   Exponential Backoff: maximum sleep amount (seconds): Default 60

        -f, --fail="script +cmds"        Fail Script: run in case of final failure

#### State

Environment variable `RETRY_ATTEMPT` is set with the current attempt number.

### Examples

No problem:

`retry echo u work good`

    u work good

Test functionality:

`retry 'echo "y u no work"; false'`

    y u no work

    Before retry #1: sleeping 0.3 seconds

    y u no work

    Before retry #2: sleeping 0.6 seconds

    y u no work

    Before retry #3: sleeping 1.2 seconds

    y u no work

    Before retry #4: sleeping 2.4 seconds

    y u no work

    Before retry #5: sleeping 4.8 seconds

    y u no work

    Before retry #6: sleeping 9.6 seconds

    y u no work

    Before retry #7: sleeping 19.2 seconds

    y u no work

    Before retry #8: sleeping 38.4 seconds

    y u no work

    Before retry #9: sleeping 60.0 seconds

    y u no work

    Before retry #10: sleeping 60.0 seconds

    y u no work

    etc..

Limit retries:

`retry -t 4 'echo "y u no work"; false'`

    y u no work

    Before retry #1: sleeping 0.3 seconds

    y u no work

    Before retry #2: sleeping 0.6 seconds

    y u no work

    Before retry #3: sleeping 1.2 seconds

    y u no work

    Before retry #4: sleeping 2.4 seconds

    y u no work

    Retries exhausted

Bad command:

`retry poop`

    bash: poop: command not found

Fail command:

`retry -t 3 -f 'echo "oh poopsicles"' 'echo "y u no work"; false'`

    y u no work

    Before retry #1: sleeping 0.3 seconds

    y u no work

    Before retry #2: sleeping 0.6 seconds

    y u no work

    Before retry #3: sleeping 1.2 seconds

    y u no work

    Retries exhausted, running fail script

    oh poopsicles

Last attempt passed:

`retry -t 3 -- 'if [ $RETRY_ATTEMPT -eq 3 ]; then echo Passed at attempt $RETRY_ATTEMPT; true; else echo Failed at attempt $RETRY_ATTEMPT; false; fi;'`

    Failed at attempt 0

    Before retry #1: sleeping 0.3 seconds

    Failed at attempt 1

    Before retry #2: sleeping 0.6 seconds

    Failed at attempt 2

    Before retry #3: sleeping 1.2 seconds

    Passed at attempt 3

### License

Apache 2.0 - go nuts