forked from reanahub/docs.reana.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(workflow-sharing): implement share-add command (reanahub#190)
Adds a new command to the CLI to share a workflow with a user. Closes reanahub/reana-client#680
- Loading branch information
1 parent
b18e391
commit 014c516
Showing
2 changed files
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
@@ -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 | ||
|