v0.8.0: Variables, Tagging mods & Syntax highlighting →

Meta-Commands

Available Commands

CommandDescription
.cacheEnable, disable or clear the query cache
.clearClear the console screen
.connectionsList active connections
.exitExit from steampipe terminal
.headerEnable or disable column headers
.helpShow steampipe help
.inspectView connection, table & column information
.multiEnable or disable multiline mode
.outputSet output format
.quitExit from steampipe terminal
.search_pathDisplay the current search path, or set the search_path by passing in a comma-separated list
.search_path_prefixSet a prefix to the current search_path
.separatorSet csv output separator
.tablesList or describe tables
.timingEnable or disable query execution timing

.cache

Enable, disable or clear the query cache.

Usage

.cache [on | off | clear]

Examples

Clear the cache

.cache clear

Turn off caching:

.cache off

Turn on caching:

.cache on

.clear

Clear the console screen.

Usage

.clear

.connections

List the active connections (schemas).

Usage

.connections

.exit

Exit the steampipe interactive query session.

Usage

.exit

Turn column headers on or off.

Usage

.header [on | off]

Examples

Turn off column headers:

.header off

Turn on column headers:

.header on

.help

Show help for Steampipe.

Usage

.help

.inspect

Inspect the available connections, tables, and columns.

Usage

.inspect [connection][.table]

Examples

List all active connections:

.inspect

List all tables in the aws connection:

.inspect aws

List the columns in the aws_ec2_instance table:

.inspect aws.aws_ec2_instance

.multi

Enable or disable multi-line mode.

Multi-line mode is off by default, and queries will be executed as soon as you hit the Enter key.

Enabling multi-line mode mode allows you to write long queries that span multiple lines. The query will not be executed when you press Enter unless it ends with a semi-colon.

Usage

.multi [on | off]

Examples

Turn off multi-line mode:

.multi off

Turn on multi-line mode:

.multi on

.output

Change the output mode. By default, the output format is table which provides a tabular, human-readable view. You can use the .output command to choose a different format. Valid values for this command are json, csv, line, and table.

Usage

.output [ table | json | csv | line]

Examples

Change the output mode to json:

.output json

Change the output mode to csv:

.output csv

Change the output mode to table:

.output table

Change the output mode to line:

.output line

.quit

Exit the steampipe interactive query session.

Usage

.quit

.separator

Set the separator string when the output mode is csv (the default is ,).

Usage

.separator {character}

Examples

Return output in pipe-separated format:

.mode CSV
.separator '|'

.search_path

Display the current search path, or set the search path by passing in a comma-separated list.

Usage

.search_path [string,string,...]

Examples

show the current search_path:

.search_path

Set the search path:

.search_path aws_prod,aws_dev,gcp_prod,slack,github,shodan

.search_path_prefix

Set a prefix to the current search path by passing in a comma-separated list.

Usage

.search_path_prefix [string,string,...]

Examples

Move the aws_123456789012 connection to the front of the search path:

.search_path_prefix aws_123456789012

Move the aws_dev and gcp_dev connections to the front of the search path:

.search_path_prefix aws_dev,gcp_dev

.tables

List the available tables.

Usage

.tables [connection]

Examples

List all tables in all active connections:

.tables

List all tables in the aws connection:

.tables aws

.timing

Turn query execution timing on or off.

Usage

.timing [on | off]

Examples

Turn off query timing:

.timing off

Turn on query timing:

.timing on