cli package

Commands

cortex.cli provides a Command Line Interface to interact with cortex.api

python -m cortex.cli

python -m cortex.cli [OPTIONS] COMMAND [ARGS]...

get-result

Prints a result from a specific snapshot. Result can be save to a file by using the -s option

python -m cortex.cli get-result [OPTIONS] USER_ID SNAPSHOT_ID RESULT

Options

-h, --host <host>

The host of the cortex.api server

-p, --port <port>

The port of the cortex.api server

-s, --save <save>

Path to save the result

Arguments

USER_ID

Required argument

SNAPSHOT_ID

Required argument

RESULT

Required argument

get-snapshot

Prints the details of a snapshot: id, timestamp and all the results it has

python -m cortex.cli get-snapshot [OPTIONS] USER_ID SNAPSHOT_ID

Options

-h, --host <host>

The host of the cortex.api server

-p, --port <port>

The port of the cortex.api server

Arguments

USER_ID

Required argument

SNAPSHOT_ID

Required argument

get-snapshots

Prints a list of all the snapshots by a specific user

python -m cortex.cli get-snapshots [OPTIONS] USER_ID

Options

-h, --host <host>

The host of the cortex.api server

-p, --port <port>

The port of the cortex.api server

Arguments

USER_ID

Required argument

get-user

Prints the details of a specific user

python -m cortex.cli get-user [OPTIONS] USER_ID

Options

-h, --host <host>

The host of the cortex.api server

-p, --port <port>

The port of the cortex.api server

Arguments

USER_ID

Required argument

get-users

Prints a list of all the users in the database, name and id only

python -m cortex.cli get-users [OPTIONS]

Options

-h, --host <host>

The host of the cortex.api server

-p, --port <port>

The port of the cortex.api server