Skip to content

Commit

Permalink
docs: add share-add command
Browse files Browse the repository at this point in the history
Adds a new command to the docs for sharing a workflow with other users.

Closes reanahub/reana-client#680
  • Loading branch information
DaanRosendal committed Nov 8, 2023
1 parent 7c48469 commit bfa9aab
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/reference/reana-client-cli-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ 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).

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

<!-- markdownlint-disable no-bare-urls -->
$ 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

## Workspace interactive commands

### open
Expand Down

0 comments on commit bfa9aab

Please sign in to comment.