CLI Environment Variables

This page is about CLI-specific environment variables. For information about Docker- and app-related environments, see the Environment documentation.

Convox pays attention to the following environment variables.

AWS_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN

AWS credentials used for convox rack install aws.

CONVOX_CONFIG

Location of Convox config directory.

CONVOX_RACK

Defines which Rack convox commands should be applied to. Overrides ./.convox/rack and ~/.convox/rack. Can be overridden by --rack flag.

CONVOX_HOST

Convox Rack or Console endpoint. If not present, console.convox.com is assumed. Overrides ~/.convox/host.

CONVOX_PASSWORD

Your Convox account password*; used when running convox login.

* or Rack API key, if you’re logging directly into a Rack.

RACK

Active Rack name. Takes precedence over the .convox/rack repository setting, but is overridden by the --rack flag. For details, see Switching between Racks.

VERSION

Custom Rack version. Used when installing a new Rack. Defaults to latest.