Skip to content

Commit

Permalink
docs(reana-client-cli-api): add share-status command docs (reanahub#190)
Browse files Browse the repository at this point in the history
Adds a new command to the docs for retrieving whom a workflow is shared
with.

Closes reanahub/reana-client#686
  • Loading branch information
DaanRosendal authored and tiborsimko committed Sep 4, 2024
1 parent 70f49d7 commit ac427f9
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/reference/reana-client-cli-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Workflow execution commands:
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.
Expand Down Expand Up @@ -319,6 +320,17 @@ Example:
<!-- markdownlint-disable no-bare-urls -->
$ 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

0 comments on commit ac427f9

Please sign in to comment.