workspace

A Steampipe workspace is a "profile" that allows you to define a unified environment that the Steampipe client can interact with. Each workspace is composed of:

• a single Steampipe database instance
• a single mod directory (which may also contain dependency mods)
• context-specific settings and options (snapshot location, query timeout, etc)

Workspace configurations can be defined in any .spc file in the ~/.steampipe/config directory, but by convention they are defined in ~/.steampipe/config/workspaces.spc file. This file may contain multiple workspace definitions that can then be referenced by name.

Steampipe workspaces allow you to define multiple named configurations and easily switch between them using the --workspace argument or STEAMPIPE_WORKSPACE environment variable.

workspace "local" {
  workspace_database = "local"  
}

workspace "dev_insights" {
  workspace_database = "local"  
  mod_location       = "~/mods/steampipe-mod-aws-insights"
}

workspace "acme_prod" {
  workspace_database = "acme/prod"
  snapshot_location  = "acme/prod"
}

To learn more, see Managing Workspaces →

Workspace Arguments

Many of the workspace arguments correspond to CLI flags and/or environment variables. Any unset arguments will assume the default values.

Steampipe Query Options

A workspace may include an options "query" block to specify values specific to the steampipe query command.

These options often correspond to CLI flags.

Steampipe Check Options

A workspace may include an options "check" block to specify values specific to the steampipe check command.

These options often correspond to CLI flags.

Steampipe Dashboard Options

A workspace may include a options "dashboard" block to specify values specific to the steampipe dashboard command.

These options often correspond to CLI flags.

Examples

workspace "default" {
  query_timeout       = 300
}

workspace "dev" {
  base               = workspace.default
  snapshot_location   = "~/snapshots/"
}

workspace "all_options" {
  pipes_host          = "pipes.turbot.com"
  pipes_token         = "tpt_999faketoken99999999_111faketoken1111111111111"
  install_dir         = "~/steampipe2"
  mod_location        = "~/src/steampipe-mod-aws-insights"  
  query_timeout       = 300
  snapshot_location   = "acme/dev"
  workspace_database  = "local" 
  search_path         = "aws,aws_1,aws_2,gcp,gcp_1,gcp_2,slack,github"
  search_path_prefix  = "aws_all"
  watch               = true
  max_parallel        = 5
  introspection       = false
  input               = true
  progress            = true
  theme               = "dark"  # light, dark, plain 
  cache               = true
  cache_ttl           = 300


  options "query" {
    autocomplete        = true
    header              = true    # true, false
    multi               = false   # true, false
    output              = "table" # json, csv, table, line
    separator           = ","     # any single char
    timing              = "on"    # on, off, verbose
  }

  options "check" {
    header              = true    # true, false
    output              = "text"  # brief, csv, html, json, md, text, snapshot or none (default "text")
    separator           = ","     # any single char
    timing              = true    # true, false
  }
  
  options "dashboard" {
    browser            = true
  }

}