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. 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.2. 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.

--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.3. list

List workflow workspace files.

reana-client list [OPTIONS]

Options

-w, --workflow <workflow>

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

--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.

5.1.4. ping

Health check REANA server.

reana-client ping [OPTIONS]

5.1.5. 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 <parameter>

Optional operational parameters 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.6. start

Start previously created workflow.

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

reana-client start [OPTIONS]

Options

-w, --workflow <workflow>

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

-at, --access-token <access_token>

Access token of the current user.

-p, --parameter <parameter>

Optional operational parameters for the workflow execution. E.g. CACHE=off.

5.1.7. 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.

--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.8. 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.

-at, --access-token <access_token>

Access token of the current user.

Arguments

SOURCES

Optional argument(s)

5.1.9. 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.

5.1.10. workflows

List all available workflows.

reana-client workflows [OPTIONS]

Options

--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.