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

All interaction related to files.

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

5.1.1.1. download

Download one or more files.

reana-client files download [OPTIONS] FILE

Options

-o, --organization <organization>

Organization whose resources will be used.

-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

FILE

Optional argument(s)

5.1.1.2. list

List workflow workspace files.

reana-client files list [OPTIONS]

Options

-o, --organization <organization>

Organization whose resources will be used.

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

Upload one of more files to the workflow workspace.

reana-client files upload [OPTIONS] FILE(s)

Options

-o, --organization <organization>

Organization whose resources will be used.

-w, --workflow <workflow>

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

-t, --access-token <access_token>

Access token of the current user.

Arguments

FILE(s)

Optional argument(s)

5.1.2. ping

Health check REANA Server.

reana-client ping [OPTIONS]

5.1.3. status

Show current status of the client session.

reana-client status [OPTIONS]

Options

-u, --user <user>

User who has created the workflow.

-o, --organization <organization>

Organization whose resources will be used.

5.1.4. workflow

All interaction related to workflows on REANA cloud.

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

5.1.4.1. create

Create a REANA compatible workflow from REANA specifications file.

reana-client workflow 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.

-o, --organization <organization>

Organization whose resources will be used.

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

List all available workflows.

reana-client workflow list [OPTIONS]

Options

-o, --organization <organization>

Organization whose resources will be used.

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

Start previously created workflow.

reana-client workflow start [OPTIONS]

Options

-o, --organization <organization>

Organization whose resources will be used.

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

5.1.4.4. status

Get status of a previously created workflow.

reana-client workflow status [OPTIONS]

Options

-o, --organization <organization>

Organization whose resources will be used.

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

Validate given REANA specification file.

reana-client workflow validate [OPTIONS]

Options

-f, --file <file>

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