New! Filter and export controls, plus lots of new mods and plugins. →

Environment Variables

Steampipe supports environment variables to allow you to change its default behavior. These are optional settings - You are not required to set any environment variables.

Note that plugins may also support environment variables, but these are plugin-specific - refer to your plugin's documentation on the hub.steampipe.io for details.

Steampipe Environment Variables

CommandDefaultDescription
STEAMPIPE_CACHEtrueEnable/disable caching [DEPRECATED]
STEAMPIPE_CACHE_TTL300The amount of time to cache results, in seconds [DEPRECATED]
STEAMPIPE_INSTALL_DIR~/.steampipeThe directory in which the Steampipe database, plugins, and supporting files can be found
STEAMPIPE_LOGwarnSet the logging output level
STEAMPIPE_UPDATE_CHECKtrueEnable/disable automatic update checking

STEAMPIPE_CACHE

This environment variable has been deprecated and will be removed in a future version. Please use the cache connection options, which allow to set both global default and per-connection settings.

Enable or disable automatic caching of results. This can significantly improve performance of some queries, at the expense of data freshness. Caching is enabled by default in Steampipe 0.3.0 and later.

Set STEAMPIPE_CACHE to true to enable caching, or false to disable.

Usage

Disable caching:

export STEAMPIPE_CACHE=false

Enable caching:

export STEAMPIPE_CACHE=true

STEAMPIPE_CACHE_TTL

This environment variable has been deprecated and will be removed in a future version. Please use the cache_ttl connection options, which allow to set both global default and per-connection settings.

The amount of time to cache results, in seconds. The default is 300 (5 minutes).

Caching must be enabled for this setting to take effect.

Usage

Set TTL to 1 minute

export STEAMPIPE_CACHE_TTL=60

STEAMPIPE_INSTALL_DIR

Sets the directory for the steampipe installation, in which the Steampipe database, plugins, and supporting files can be found.

Steampipe is distributed as a single binary - when you install Steampipe, either via brew install or via the curl script, the steampipe binary is installed into your path. The first time that you run Steampipe, it will download and install the embedded database, foreign data wrapper extension, and other required files. By default, these files are installed to ~/.steampipe, however you can change this location with the STEAMPIPE_INSTALL_DIR environment variable or the --install-dir command line argument.

Steampipe will read the STEAMPIPE_INSTALL_DIR variable each time it runs; if it's not set, Steampipe will use the default path (~/.steampipe). If you wish to ALWAYS run Steampipe from the alternate path, you should set your environment variable in a way that will persist across sessions (in your .profile for example).

To install a new Steampipe instance into an alternate path, simply specify the path in STEAMPIPE_INSTALL_DIR and then run a steampipe command (alternatively, use the --install-dir argument). If the specified directory is empty or files are missing, Steampipe will install and update the database and files to STEAMPIPE_INSTALL_DIR. If the directory does not exist, Steampipe will create it.

It is possible to have multiple, parallel steampipe instances on a given machine using STEAMPIPE_INSTALL_DIR as long as they are running on a different port.

Usage

Set the STEAMPIPE_INSTALL_DIR to ~/mypath. You will likely want to set this in your .profile.

export STEAMPIPE_INSTALL_DIR=~/mypath

STEAMPIPE_LOG

Sets the output logging level. Standard log levels are supported (trace, debug, info, warn, error). By default, the log level is warn.

Logs are written to ~/.steampipe/logs/

Usage

export STEAMPIPE_LOG=trace

STEAMPIPE_UPDATE_CHECK

Enable or disable automatic update checking. Update checking is enabled by default. Set to false to disable update checking.

Usage

Disable update check:

export STEAMPIPE_UPDATE_CHECK=false

Enable update check:

export STEAMPIPE_UPDATE_CHECK=true

or

unset STEAMPIPE_UPDATE_CHECK