rush icon indicating copy to clipboard operation
rush copied to clipboard

Suggestion to improve documentation with practical examples.

Open teebu opened this issue 3 years ago • 2 comments

I just gotta say, this program is pretty cool, but hard to figure out. The documentation does not make it easy. Please include more practical examples, not just echos. Here's something I'm using it for:

Starting two (or more) azure cloudfunctions. run.sh

#!/bin/bash
echo '
    cd operator_a && func start -p 7071; 
    cd service_worker_a && func start -p 7072
    ' \
    | rush --immediate-output -k -T b -D ';'   ' {} '

-D = delimiter (;) -T = trim both sides of input (trying to have a neat script) --immediate-output = only way to get output -k = keep order (probably not important?)

teebu avatar Jun 28 '22 02:06 teebu

I thought 18 examples are sufficient. :smiling_face_with_tear:

Input can be given either from the STDIN (the echos) or files (-i/--infile); it should be flexible enough.

shenwei356 avatar Jun 28 '22 02:06 shenwei356

No that is way too cryptic. Every one of those is very difficult to understand. It took me an hour to understand, and I was about to give up but eventually I stumbled onto a good enough example I can replicate. Took a lot of trial and error to get it going.

teebu avatar Jun 28 '22 18:06 teebu

The help doc is updated.

shenwei356 avatar Aug 25 '23 08:08 shenwei356