Skip to content

Commit

Permalink
docs(workflow-sharing): add list --shared arguments (reanahub#190)
Browse files Browse the repository at this point in the history
Adds extra docs for `list` command to the docs for new sharing related
arguments.

Closes reanahub/reana-client#687
  • Loading branch information
DaanRosendal committed Mar 18, 2024
1 parent 4c79d0f commit 9b9fab4
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion docs/reference/reana-client-cli-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,20 @@ List all workflows and sessions.
The ``list`` command lists workflows and sessions. By default, the list of
workflows is returned. If you would like to see the list of your open
interactive sessions, you need to pass the ``--sessions`` command-line
option.
option. If you would like to see the list of all workflows, including those
shared with you, you need to pass the ``--shared`` command-line option.

Along with specific user emails, you can pass the following special values
to the ``--shared-by`` and ``--shared-with`` command-line options:

- ``--shared-by anybody``: list workflows shared with you by anybody.

- ``--shared-with anybody``: list your shared workflows exclusively.

- ``--shared-with nobody``: list your unshared workflows exclusively.

- ``--shared-with [email protected],[email protected]``: list workflows shared
with either [email protected] or [email protected]

Example:

Expand All @@ -136,6 +149,12 @@ Example:

$ reana-client list --verbose --bytes

$ reana-client list --shared

$ reana-client list --shared-by [email protected]

$ reana-client list --shared-with anybody

### create

Create a new workflow.
Expand Down

0 comments on commit 9b9fab4

Please sign in to comment.