Search…
CLI commands

deploy

create or update apis
Usage:
cortex deploy [CONFIG_FILE] [flags]
Flags:
-e, --env string environment to use
-f, --force override the in-progress api update
-y, --yes skip prompts
-o, --output string output format: one of pretty|json (default "pretty")
-h, --help help for deploy

get

get information about apis or jobs
Usage:
cortex get [API_NAME] [JOB_ID] [flags]
Flags:
-e, --env string environment to use
-w, --watch re-run the command every 2 seconds
-o, --output string output format: one of pretty|json (default "pretty")
-v, --verbose show additional information (only applies to pretty output format)
-h, --help help for get

describe

describe an api
Usage:
cortex describe [API_NAME] [flags]
Flags:
-e, --env string environment to use
-w, --watch re-run the command every 2 seconds
-h, --help help for describe

logs

get the logs for a workload
Usage:
cortex logs API_NAME [JOB_ID] [flags]
Flags:
-e, --env string environment to use
-y, --yes skip prompts
--random-pod stream logs from a random pod
-h, --help help for logs

refresh

restart all replicas for an api (without downtime)
Usage:
cortex refresh API_NAME [flags]
Flags:
-e, --env string environment to use
-f, --force override the in-progress api update
-o, --output string output format: one of pretty|json (default "pretty")
-h, --help help for refresh

delete

delete an api or stop a job
Usage:
cortex delete API_NAME [JOB_ID] [flags]
Flags:
-e, --env string environment to use
-f, --force delete the api without confirmation
-c, --keep-cache keep cached data for the api
-o, --output string output format: one of pretty|json (default "pretty")
-h, --help help for delete

cluster up

spin up a cluster on aws
Usage:
cortex cluster up CLUSTER_CONFIG_FILE [flags]
Flags:
-e, --configure-env string name of environment to configure (default: the name of your cluster)
-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
-n, --name string name of the cluster
-r, --region string aws region of the cluster
-o, --output string output format: one of pretty|json|yaml (default "pretty")
-e, --configure-env string name of environment to configure
-d, --debug save the current cluster state to a file
--print-config print the cluster config
-y, --yes skip prompts
-h, --help help for info

cluster configure

update the cluster's configuration
Usage:
cortex cluster configure CLUSTER_CONFIG_FILE [flags]
Flags:
-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
-n, --name string name of the cluster
-r, --region string aws region of the cluster
-y, --yes skip prompts
--keep-aws-resources skip deletion of resources that cortex provisioned on aws (bucket contents, ebs volumes, log group)
-h, --help help for down

cluster export

download the configurations for all APIs
Usage:
cortex cluster export [flags]
Flags:
-c, --config string path to a cluster configuration file
-n, --name string name of the cluster
-r, --region string aws region of the cluster
-h, --help help for export

cluster health

inspect the health of components in the cluster
Usage:
cortex cluster health [flags]
Flags:
-c, --config string path to a cluster configuration file
-n, --name string name of the cluster
-r, --region string aws region of the cluster
-o, --output string output format: one of pretty|json (default "pretty")
-h, --help help for health

env configure

configure an environment
Usage:
cortex env configure [ENVIRONMENT_NAME] [flags]
Flags:
-o, --operator-endpoint string set the operator endpoint without prompting
-h, --help help for configure

env list

list all configured environments
Usage:
cortex env list [flags]
Flags:
-o, --output string output format: one of pretty|json (default "pretty")
-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 rename

rename an environment
Usage:
cortex env rename EXISTING_NAME NEW_NAME [flags]
Flags:
-h, --help help for rename

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
-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
Copy link
Outline
deploy
get
describe
logs
refresh
delete
cluster up
cluster info
cluster configure
cluster down
cluster export
cluster health
env configure
env list
env default
env rename
env delete
version
completion