5. CLI API

5.1. reana-client

REANA client for interacting with REANA server.

reana-client [OPTIONS] COMMAND [ARGS]...

Options

-l, --loglevel <loglevel>

Sets log level

5.1.1. close

Close an interactive workflow session

reana-client close [OPTIONS]

Options

-w, --workflow <workflow>

Name and run number to be deleted. Overrides value of REANA_WORKON environment variable.

-at, --access-token <access_token>

Access token of the current user.

5.1.2. create

Create a REANA compatible workflow from REANA specifications file.

reana-client create [OPTIONS]

Options

-f, --file <file>

REANA specifications file describing the workflow and context which REANA should execute.

-n, --name <name>

Name of the workflow.

--skip-validation

If set, specifications file is not validated before submitting it’s contents to REANA server.

-at, --access-token <access_token>

Access token of the current user.

5.1.3. delete

Delete a workflow run. By default removes all cached information of the given workflow and hides it from the workflow list. Workspaces of deleted workflows are accessible to retrieve files, to remove the workspace too pass –include-workspace flag. By passing –include-all-runs all workflows with the same will be deleted. The –include-records flag will delete all workflow data from the database and remove its workspace.

reana-client delete [OPTIONS]

Options

--include-all-runs

Delete all runs of a given workflow.

--include-workspace

Delete workflow workspace from REANA.

--include-records

Delete all records of workflow, including database entries and workspace.

-w, --workflow <workflow>

Name and run number to be deleted. Overrides value of REANA_WORKON environment variable.

-at, --access-token <access_token>

Access token of the current user.

5.1.4. diff

Show differences between two workflows.

reana-client diff [OPTIONS] WORKFLOW_A WORKFLOW_B

Options

-q, --brief

If not set, differences in the contents of the files in the twoworkspaces are shown.

-u, -U, --unified <context_lines>

Sets number of context lines for workspace diff output.

-at, --access-token <access_token>

Access token of the current user.

Arguments

WORKFLOW_A

Required argument

WORKFLOW_B

Required argument

5.1.5. download

Download all output files declared in the reana.yamlspecification or download files listed as FILE command-line arguments. Note that downloading directories is not yet supported.

reana-client download [OPTIONS] FILES

Options

-w, --workflow <workflow>

Name or UUID of that workflow where files should downloaded from. Overrides value of REANA_WORKON environment variable.

-o, --output-directory <output_directory>

Path to the directory where files will be downloaded.

-at, --access-token <access_token>

Access token of the current user.

Arguments

FILES

Optional argument(s)

5.1.6. du

Get disk usage of a workflow.

reana-client du [OPTIONS]

Options

-w, --workflow <workflow>

Name or UUID of the workflow to display the disk usage. Overrides value of REANA_WORKON environment variable.

-at, --access-token <access_token>

Access token of the current user.

-s, --summarize

Display total.

5.1.7. list

List all available workflows.

reana-client list [OPTIONS]

Options

-s, --sessions

List all open interactive sessions.

--format <_filter>

Format output according to column titles or column values (case-sensitive). Use <colum_name>=<columnn_value> format. For E.g. dislpay workflow with failed status and named test_workflow –format status=failed,name=test_workflow.

--json

Get output in JSON format.

--all

Show all workflows including deleted ones.

-v, --verbose

Set status information verbosity.

-at, --access-token <access_token>

Access token of the current user.

5.1.8. logs

Get workflow logs.

reana-client logs [OPTIONS]

Options

-w, --workflow <workflow>

Name or UUID of the workflow whose logs should be fetched. Overrides value of REANA_WORKON environment variable.

--json

Get output in JSON format.

-at, --access-token <access_token>

Access token of the current user.

5.1.9. ls

List workflow workspace files.

reana-client ls [OPTIONS]

Options

-w, --workflow <workflow>

Name or UUID of the workflow whose files should be listed. Overrides value of REANA_WORKON environment variable.

--format <_filter>

Format output according to column titles or column values (case-sensitive). Use <colum_name>=<columnn_value> format. For E.g. dislpay FILES named data.txt –format name=data.txt.

--json

Get output in JSON format.

-at, --access-token <access_token>

Access token of the current user.

5.1.10. mv

Move files within workspace.

Examples:n t $ reana-client mv data/input.txt input/input.txt

reana-client mv [OPTIONS] SOURCE TARGET

Options

-w, --workflow <workflow>

Name or UUID of the workflow you are moving files for. Overrides value of REANA_WORKON environment variable.

-at, --access-token <access_token>

Access token of the current user.

Arguments

SOURCE

Required argument

TARGET

Required argument

5.1.11. open

Open an interactive session inside the workflow workspace

reana-client open [OPTIONS] interactive-session-type

Options

-w, --workflow <workflow>

Name and run number to be deleted. Overrides value of REANA_WORKON environment variable.

-i, --image <image>

Docker image which will be used to spawn the interactive session. Overrides the default image for the selected type.

-at, --access-token <access_token>

Access token of the current user.

Arguments

interactive-session-type

Required argument

5.1.12. ping

Health check REANA server.

reana-client ping [OPTIONS]

5.1.13. rm

Delete the specified file or pattern.

reana-client rm [OPTIONS] SOURCES

Options

-w, --workflow <workflow>

Name or UUID of the workflow you are deleting files for. Overrides value of REANA_WORKON environment variable.

-at, --access-token <access_token>

Access token of the current user.

Arguments

SOURCES

Optional argument(s)

5.1.14. run

Create, upload and start the REANA workflow.

reana-client run [OPTIONS] SOURCES

Options

-f, --file <file>

REANA specifications file describing the workflow and context which REANA should execute.

-n, --name <name>

Name of the workflow.

--skip-validation

If set, specifications file is not validated before submitting it’s contents to REANA server.

-p, --parameter <parameters>

Additional input parameters to override original ones from reana.yaml. E.g. -p myparam1=myval1 -p myparam2=myval2.

-o, --option <options>

Additional operatioal options for the workflow execution. E.g. CACHE=off.

-at, --access-token <access_token>

Access token of the current user.

Arguments

SOURCES

Optional argument(s)

5.1.15. start

Start previously created workflow.

The workflow execution can be further influenced by setting input prameters using -p or –parameters flag or by setting operational options using -o or –options. The input parameters and operational options can be repetitive. For example, to disable caching for the Serial workflow engine, you can set -o CACHE=off.

reana-client start [OPTIONS]

Options

-w, --workflow <workflow>

Name or UUID of the workflow to be started. Overrides value of REANA_WORKON environment variable.

-at, --access-token <access_token>

Access token of the current user.

-p, --parameter <parameters>

Additional input parameters to override original ones from reana.yaml. E.g. -p myparam1=myval1 -p myparam2=myval2.

-o, --option <options>

Additional operatioal options for the workflow execution. E.g. CACHE=off. (workflow engine - serial) E.g. –debug (workflow engine - cwl)

5.1.16. status

Get status of a previously created workflow.

reana-client status [OPTIONS]

Options

-w, --workflow <workflow>

Name or UUID of the workflow whose status should be resolved. Overrides value of REANA_WORKON environment variable.

--filter <_filter>

Filter output according to column titles (case-sensitive).

--json

Get output in JSON format.

-at, --access-token <access_token>

Access token of the current user.

-v, --verbose

Set status information verbosity.

5.1.17. stop

Stop a running workflow

reana-client stop [OPTIONS]

Options

--force

Stop a workflow without waiting for jobs to finish.

-w, --workflow <workflow>

Name and run number to be stopped. Overrides value of REANA_WORKON environment variable.

-at, --access-token <access_token>

Access token of the current user.

5.1.18. upload

Upload all input sources declared in the reana.yamlspecification or upload files and directories listed as SOURCE command-line arguments. If a symbolic link is provided, it is resolved and a hard copy is uploaded.

reana-client upload [OPTIONS] SOURCES

Options

-w, --workflow <workflow>

Name or UUID of the workflow you are uploading files for. Overrides value of REANA_WORKON environment variable.

-at, --access-token <access_token>

Access token of the current user.

Arguments

SOURCES

Optional argument(s)

5.1.19. validate

Validate the REANA specification.

reana-client validate [OPTIONS]

Options

-f, --file <file>

REANA specifications file describing the workflow and context which REANA should execute.