Skip to content

Commit

Permalink
docs(reana-client-cli-api): add list command sharing options (#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 authored and tiborsimko committed Sep 4, 2024
1 parent ac427f9 commit 3668003
Showing 1 changed file with 24 additions and 9 deletions.
33 changes: 24 additions & 9 deletions docs/reference/reana-client-cli-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,16 +126,34 @@ 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.

Example:
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]``: list workflows shared with [email protected]

Examples:

$ reana-client list --all

$ reana-client list --sessions

$ 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 Expand Up @@ -302,11 +320,9 @@ users will be able to view the workflow but not modify it.

Examples:

<!-- markdownlint-disable no-bare-urls -->
$ reana-client share-add -w myanalysis.42 --user [email protected]
$ reana-client share-add -w myanalysis.42 --user [email protected]

<!-- markdownlint-disable no-bare-urls -->
$ reana-client share-add -w myanalysis.42 --user [email protected] --user [email protected] --message "Please review my analysis" --valid-until 2024-12-31
$ reana-client share-add -w myanalysis.42 --user [email protected] --user [email protected] --message "Please review my analysis" --valid-until 2025-12-31

### share-remove

Expand All @@ -317,8 +333,7 @@ will no longer be visible to the users with whom it was shared.

Example:

<!-- markdownlint-disable no-bare-urls -->
$ reana-client share-remove -w myanalysis.42 --user [email protected]
$ reana-client share-remove -w myanalysis.42 --user [email protected]

### share-status

Expand All @@ -329,7 +344,7 @@ shared.

Example:

$ reana-client share-status -w myanalysis.42
$ reana-client share-status -w myanalysis.42

## Workspace interactive commands

Expand Down

0 comments on commit 3668003

Please sign in to comment.