Skip to content

Commit

Permalink
docs(workflow-sharing): implement share-add command (reanahub#190)
Browse files Browse the repository at this point in the history
Adds a new command to the CLI to share a workflow with a user.

Closes reanahub/reana-client#680
  • Loading branch information
DaanRosendal committed Mar 18, 2024
1 parent b18e391 commit 014c516
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
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
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 014c516

Please sign in to comment.