Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add list --shared arguments #190

Merged
merged 4 commits into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The list of contributors in alphabetical order:
- [Agisilaos Kounelis](https://orcid.org/0000-0001-9312-3189)
- [Audrius Mecionis](https://orcid.org/0000-0002-3759-1663)
- [Clemens Lange](https://orcid.org/0000-0002-3632-3157)
- [Daan Rosendal](https://orcid.org/0000-0002-3447-9000)
- [Diego Rodriguez](https://orcid.org/0000-0003-0649-2002)
- [Domenic Gosein](https://orcid.org/0000-0002-1546-0435)
- [Elena Gazzarrini](https://orcid.org/0000-0001-5772-5166)
Expand Down
64 changes: 62 additions & 2 deletions docs/reference/reana-client-cli-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ Workflow execution commands:
stop Stop a running workflow.
validate Validate workflow specification file.

Workflow sharing commands:
share-add Share a workflow with other users (read-only).
share-remove Unshare a workflow.
share-status Show with whom a workflow is shared.

Workspace interactive commands:
close Close an interactive session.
open Open an interactive session inside the workspace.
Expand Down Expand Up @@ -121,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 @@ -286,6 +309,43 @@ Examples:

$ reana-client run -w myanalysis-test-big -p myparam=mybigvalue

## Workflow sharing commands

### share-add

Share a workflow with other users (read-only).

The `share-add` command allows sharing a workflow with other users. The
users will be able to view the workflow but not modify it.

Examples:

$ reana-client share-add -w myanalysis.42 --user [email protected]

$ 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

Unshare a workflow.

The `share-remove` command allows for unsharing a workflow. The workflow
will no longer be visible to the users with whom it was shared.

Example:

$ reana-client share-remove -w myanalysis.42 --user [email protected]

### share-status

Show with whom a workflow is shared.

The `share-status` command allows for checking with whom a workflow is
shared.

Example:

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

## Workspace interactive commands

### open
Expand Down