Environment Variables Reference
Currently, all environment variables are experimental. If you are experiencing a use case which might justify defining any variables as non-experimental, please reach out to us through the user forums (https://community.activestate.com).
User Configurable
User configurable environment variables permit users to control various behaviors of the State Tool.
ACTIVESTATE_CLI_CONFIGDIR
- Override the configuration directory location
ACTIVESTATE_CLI_CACHEDIR
- Override the cache directory location
ACTIVESTATE_PROJECT
- Predefine the activestate.yaml (absolute path) used for activated states
ACTIVESTATE_PRIVATE_KEY
- Predefine the private key (not file path) used to decrypt secrets
- You can obtain the value by running
state export private-key
once authenticated
ACTIVESTATE_API_KEY
- Predefine the API key token to use for authentication
- Use with
ACTIVESTATE_PRIVATE_KEY
to bypass authentication by plain text password
ACTIVESTATE_CLI_DISABLE_UPDATES
- Set to
true
to disable State Tool automatically updating itself
ACTIVESTATE_CLI_DISABLE_ANALYTICS
- Set to
true
to disable State Tool from sending analytics data
Post-Activation
After activation (state activate
), the following environment variables are set.
ACTIVESTATE_PROJECT
- The absolute path to the activestate.yaml of the activated project
ACTIVESTATE_ACTIVATED
- The absolute path of the directory containing the activestate.yaml of the activated project
ACTIVESTATE_ACTIVATED_ID
- The unique “activation id” which can be used for debugging