Skip to content

Commit

Permalink
docs: add reana-client's human-readable option
Browse files Browse the repository at this point in the history
  • Loading branch information
Diego Rodriguez committed Oct 30, 2020
1 parent a7fd66e commit 8ac286f
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions docs/reference/reana-client-cli-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,9 @@ Example:

$ reana-client delete -w myanalysis.42

$ reana-client delete -w myanalysis.42 --include-records
$ reana-client delete -w myanalysis.42 --include-all-runs

$ reana-client delete -w myanalysis.42 --include-workspace

### diff

Expand All @@ -170,7 +172,7 @@ Start previously created workflow.
The `start` command allows to start previously created workflow. The
workflow execution can be further influenced by passing input prameters
using `-p` or `--parameters` flag and by setting additional operational
options using `-o` or `--options`. The input parameters and operational
options using `-o` or `--options`. The input parameters and operational
options can be repetitive. For example, to disable caching for the Serial
workflow engine, you can set `-o CACHE=off`.

Expand All @@ -188,12 +190,12 @@ The `restart` command allows to restart a previous workflow on the same
workspace.

Note that workflow restarting can be used in a combination with operational
options ``FROM`` and ``TARGET``. You can also pass a modified workflow
specification with ``-f`` or `--file`` flag.
options `FROM` and `TARGET`. You can also pass a modified workflow
specification with `-f` or `--file`` flag.

You can furthermore use modified input prameters using `-p` or
`--parameters` flag and by setting additional operational options using
`-o` or `--options`. The input parameters and operational options can be
`-o` or `--options`. The input parameters and operational options can be
repetitive.

Examples:
Expand Down Expand Up @@ -222,7 +224,7 @@ Examples:

### logs

Get workflow logs.
Get workflow logs.

The `logs` command allows to retrieve logs of running workflow. Note that
only finished steps of the workflow are returned, the logs of the currently
Expand Down Expand Up @@ -312,6 +314,8 @@ Examples:

$ reana-client ls --workflow myanalysis.42

$ reana-client ls --workflow myanalysis.42 --human-readable

### download

Download workspace files.
Expand Down Expand Up @@ -376,7 +380,7 @@ Examples:

$ reana-client du -w myanalysis.42 -s

$ reana-client du -w myanalysis.42 --bytes
$ reana-client du -w myanalysis.42 -s --human-readable

## Secret management commands

Expand Down

0 comments on commit 8ac286f

Please sign in to comment.