Skip to content

Latest commit

 

History

History
254 lines (186 loc) · 5.46 KB

cli.md

File metadata and controls

254 lines (186 loc) · 5.46 KB
Raw

CLI commands

deploy

create or update apis

Usage:
  cortex deploy [CONFIG_FILE] [flags]

Flags:
  -e, --env string   environment to use (default "local")
  -f, --force        override the in-progress api update
  -y, --yes          skip prompts
  -h, --help         help for deploy

get

get information about apis

Usage:
  cortex get [API_NAME] [flags]

Flags:
  -e, --env string   environment to use (default "local")
  -w, --watch        re-run the command every second
  -h, --help         help for get

logs

stream logs from an api

Usage:
  cortex logs API_NAME [flags]

Flags:
  -e, --env string   environment to use (default "local")
  -h, --help         help for logs

refresh

restart all replicas for an api (witout downtime)

Usage:
  cortex refresh API_NAME [flags]

Flags:
  -e, --env string   environment to use (default "local")
  -f, --force        override the in-progress api update
  -h, --help         help for refresh

predict

make a prediction request using a json file

Usage:
  cortex predict API_NAME JSON_FILE [flags]

Flags:
  -e, --env string   environment to use (default "local")
  -h, --help         help for predict

delete

delete an api

Usage:
  cortex delete API_NAME [flags]

Flags:
  -e, --env string   environment to use (default "local")
  -f, --force        delete the api without confirmation
  -c, --keep-cache   keep cached data for the api
  -h, --help         help for delete

cluster up

spin up a cluster

Usage:
  cortex cluster up [flags]

Flags:
  -c, --config string   path to a cluster configuration file
  -e, --env string      environment to configure (default "aws")
  -y, --yes             skip prompts
  -h, --help            help for up

cluster info

get information about a cluster

Usage:
  cortex cluster info [flags]

Flags:
  -c, --config string   path to a cluster configuration file
  -e, --env string      environment to configure (default "aws")
  -d, --debug           save the current cluster state to a file
  -y, --yes             skip prompts
  -h, --help            help for info

cluster configure

update a cluster's configuration

Usage:
  cortex cluster configure [flags]

Flags:
  -c, --config string   path to a cluster configuration file
  -e, --env string      environment to configure (default "aws")
  -y, --yes             skip prompts
  -h, --help            help for configure

cluster down

spin down a cluster

Usage:
  cortex cluster down [flags]

Flags:
  -c, --config string   path to a cluster configuration file
  -y, --yes             skip prompts
  -h, --help            help for down

env configure

configure an environment

Usage:
  cortex env configure [ENVIRONMENT_NAME] [flags]

Flags:
  -p, --provider string                set the provider without prompting
  -o, --operator-endpoint string       set the operator endpoint without prompting
  -k, --aws-access-key-id string       set the aws access key id without prompting
  -s, --aws-secret-access-key string   set the aws secret access key without prompting
  -r, --aws-region string              set the aws region without prompting
  -h, --help                           help for configure

env list

list all configured environments

Usage:
  cortex env list [flags]

Flags:
  -h, --help   help for list

env default

set the default environment

Usage:
  cortex env default [ENVIRONMENT_NAME] [flags]

Flags:
  -h, --help   help for default

env delete

delete an environment configuration

Usage:
  cortex env delete [ENVIRONMENT_NAME] [flags]

Flags:
  -h, --help   help for delete

version

print the cli and cluster versions

Usage:
  cortex version [flags]

Flags:
  -e, --env string   environment to use (default "local")
  -h, --help         help for version

completion

generate shell completion scripts

to enable cortex shell completion:
    bash:
        add this to ~/.bash_profile (mac) or ~/.bashrc (linux):
            source <(cortex completion bash)

        note: bash-completion must be installed on your system; example installation instructions:
            mac:
                1) install bash completion:
                   brew install bash-completion
                2) add this to your ~/.bash_profile:
                   source $(brew --prefix)/etc/bash_completion
                3) log out and back in, or close your terminal window and reopen it
            ubuntu:
                1) install bash completion:
                   apt update && apt install -y bash-completion  # you may need sudo
                2) open ~/.bashrc and uncomment the bash completion section, or add this:
                   if [ -f /etc/bash_completion ] && ! shopt -oq posix; then . /etc/bash_completion; fi
                3) log out and back in, or close your terminal window and reopen it

    zsh:
        option 1:
            add this to ~/.zshrc:
                source <(cortex completion zsh)
            if that failed, you can try adding this line (above the source command you just added):
                autoload -Uz compinit && compinit
        option 2:
            create a _cortex file in your fpath, for example:
                cortex completion zsh > /usr/local/share/zsh/site-functions/_cortex

Note: this will also add the "cx" alias for cortex for convenience

Usage:
  cortex completion SHELL [flags]

Flags:
  -h, --help   help for completion