Skip to content

Commit

Permalink
docs: add share-remove command
Browse files Browse the repository at this point in the history
Adds a new command to the docs for unsharing a workflow.

Closes reanahub/reana-client#681
  • Loading branch information
DaanRosendal committed Nov 8, 2023
1 parent d9b496c commit 0df6939
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/reference/reana-client-cli-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ Workflow execution commands:
validate Validate workflow specification file.

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

Workspace interactive commands:
close Close an interactive session.
Expand Down Expand Up @@ -306,6 +307,18 @@ $ reana-client share-add -w myanalysis.42 --user bob@cern.ch
<!-- markdownlint-disable no-bare-urls -->
$ reana-client share-add -w myanalysis.42 --user bob@cern.ch --user cecile@cern.ch --message "Please review my analysis" --valid-until 2024-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:

<!-- markdownlint-disable no-bare-urls -->
$ reana-client share-remove -w myanalysis.42 --user bob@example.org

## Workspace interactive commands

### open
Expand Down

0 comments on commit 0df6939

Please sign in to comment.