From 8ac286f0a6d972052bd7c083b8cbc5d5be02b346 Mon Sep 17 00:00:00 2001 From: Diego Rodriguez Date: Fri, 30 Oct 2020 08:33:15 +0100 Subject: [PATCH] docs: add reana-client's human-readable option * Closes reanahub/reana-server#296. --- docs/reference/reana-client-cli-api/index.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/reference/reana-client-cli-api/index.md b/docs/reference/reana-client-cli-api/index.md index d8ac4df..db20af2 100644 --- a/docs/reference/reana-client-cli-api/index.md +++ b/docs/reference/reana-client-cli-api/index.md @@ -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 @@ -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`. @@ -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: @@ -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 @@ -312,6 +314,8 @@ Examples: $ reana-client ls --workflow myanalysis.42 + $ reana-client ls --workflow myanalysis.42 --human-readable + ### download Download workspace files. @@ -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