[Steampipe Logo](https://steampipe.io?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) [![plugins](https://img.shields.io/badge/apis_supported-137-blue)](https://hub.steampipe.io/plugins?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme)   [![benchmarks](https://img.shields.io/badge/controls-4733-blue)](https://hub.steampipe.io/mods?objectives=compliance?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme)   [![dashboards](https://img.shields.io/badge/dashboards-708-blue)](https://hub.steampipe.io/mods?objectives=dashboard?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme)   [![slack](https://img.shields.io/badge/slack-1959-blue)](https://turbot.com/community/join?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme)   [![maintained by](https://img.shields.io/badge/maintained%20by-Turbot-blue)](https://turbot.com?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) Steampipe is the universal interface to APIs. Use SQL to query cloud infrastructure, SaaS, code, logs, and more. With [Steampipe](https://steampipe.io?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) you can: - **Query** → Use SQL to [query](https://steampipe.io/docs/query/overview?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) (and join across!) [APIs](https://hub.steampipe.io/plugins?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme). - **Check** → Ensure that cloud resources comply with [security benchmarks](https://steampipe.io/docs/check/overview?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) such as CIS, NIST, and SOC2. - **Visualize** → View [prebuilt dashboards](https://steampipe.io/docs/dashboard/overview?objectives=dashboard&utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) or [build your own](https://steampipe.io/docs/mods/writing-dashboards?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme). ## Steampipe CLI: The SQL console for API queries The Steampipe community has grown a suite of [plugins](https://hub.steampipe.io/plugins?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) that map APIs to tables.
Cloud AWS, Alibaba, Azure, GCP, IBM, Oracle …
SaaS Airtable, Jira, GitHub, Google Workspace, Microsoft 365, Salesforce, Slack, Stripe, Zoom …
Security CrowdStrike, GitGuardian, Have I Been Pwned, PAN-OS, Shodan, Trivy, VirusTotal …
Identity Azure AD, Duo, Keycloak, Google Directory, LDAP …
DevOps Docker, Grafana, Kubernetes, Prometheus …
Net Baleen, Cloudflare, crt.sh, Gandi, IMAP, ipstack, Tailscale, updown.io, WHOIS …
IaC CloudFormation, Terraform …
Logs Algolia, AWS CloudWatch, Datadog, Splunk …
Social HackerNews, Twitter, Reddit, RSS …
Your API Build your own custom plugins
The [interactive query shell](https://steampipe.io/docs/query/query-shell?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) is one way you can query those tables. You can also use psql, pgcli, Metabase, Tableau, or [any client](https://steampipe.io/docs/cloud/integrations/overview?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) that can connect to Postgres. ### Get started with the CLI
Install Steampipe
The downloads page shows you how but tl;dr: Linux or WSL ```sh sudo /bin/sh -c "$(curl -fsSL https://raw.githubusercontent.com/turbot/steampipe/main/install.sh)" ``` MacOS ```sh brew tap turbot/tap brew install steampipe ```
Add a plugin
Choose a plugin from the [hub](https://hub.steampipe.io?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme), for example: [Net](https://hub.steampipe.io/plugins/turbot/net?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme). Run the `steampipe plugin` command to install it. ```sh steampipe plugin install net ```
Run steampipe query
Launch the interactive shell. ```sh steampipe query ``` Run your first query! ```sql select * from net_certificate where domain = 'google.com'; ```
Learn more about the CLI - It's [just SQL](https://steampipe.io/docs/sql/steampipe-sql?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme)! - You can run queries [on the command line](https://steampipe.io/docs/query/overview?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme#non-interactive-batch-query-mode) and include them in scripts. - Other [commands](https://steampipe.io/docs/reference/cli/overview?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) run benchmarks, launch Steampipe as a service, and start the dashboard server. - [Meta-commands](https://steampipe.io/docs/reference/dot-commands/overview?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) control caching, [environment variables](https://steampipe.io/docs/reference/env-vars/overview), the [search path](https://steampipe.io/docs/guides/search-path?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme), and more. - Queries can run in [batch mode](https://steampipe.io/docs/query/batch-query?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme). - You can bundle connections (e.g. for many AWS accounts) using an [aggregator](https://steampipe.io/docs/managing/connections?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme#using-aggregators).
Build and develop the CLI Prerequisites: - [Golang](https://golang.org/doc/install) Version 1.19 or higher. Clone: ```sh git clone git@github.com:turbot/steampipe cd steampipe ``` Build, which automatically installs the new version to your `/usr/local/bin/steampipe` directory: ``` make ``` Check the verison ``` $ steampipe -v steampipe version 0.18.1 ``` Install a plugin ``` $ steampipe plugin install steampipe ``` Try it! ``` steampipe query > .inspect steampipe +-----------------------------------+-----------------------------------+ | TABLE | DESCRIPTION | +-----------------------------------+-----------------------------------+ | steampipe_registry_plugin | Steampipe Registry Plugins | | steampipe_registry_plugin_version | Steampipe Registry Plugin Version | +-----------------------------------+-----------------------------------+ > select * from steampipe_registry_plugin; ```
## Steampipe Mods: Dashboards and benchmarks The Steampipe community has also grown a suite of [mods](https://hub.steampipe.io/mods?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) which are sets of **dashboards** that visualize your resources and **benchmarks** that check your cloud resources for compliance.
Compliance Check AWS, Azure, GCP, etc for compliance with HIPAA, PCI, etc
Cost Review what AWS, Azure, GCP, and other clouds are costing you
Insights Visualize cloud resources with charts, tables, and interactive widgets
Security Use CIS, NIST, FedRAMP etc to assess the security of AWS, Azure, GCP, etc
Tags Verify the consistency of tags applied to AWS, Azure, and GCP resources
Your mod Build your own benchmarks and dashboards
### Running dashboards and benchmarks ![benchmarks-and-dashboards](https://user-images.githubusercontent.com/46509/193875366-7d10ca8b-601a-4d93-a333-5c62ea86374b.gif) Dashboards and benchmarks use SQL to gather data and HCL to flow the data into [dashboard widgets](https://steampipe.io/blog/dashboards-as-code?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) and [benchmark controls](https://steampipe.io/blog/release-0-11-0?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme#composable-mods). You can use the existing suites of benchmarks and dashboards, or build derivative versions, or create your own. ### Get started with dashboards and benchmarks
Install the Net Insights mod
The Net Insights mod works with the Net plugin shown above. To run it, first clone its repo and change to that directory. ```sh git clone https://github.com/turbot/steampipe-mod-net-insights cd steampipe-mod-net-insights ```

Run benchmarks in the CLI All the benchmarks: ```sh steampipe check all ``` A single benchmark: ```sh steampipe check benchmark.dns_best_practices ``` A single control: ```sh steampipe check control.dns_ns_name_valid ``` Available formats include JSON, CSV, HTML, and ASFF. You can use custom output templates to create new output formats.
Run benchmarks as dashboards
Launch the dashboard server: `steampipe dashboard`, then open `http://localhost:9194` in your browser. The home page lists available dashboards. Click `DNS Best Practices` to view that dashboard. Note that the default domains are `microsoft.com` and `github.com`. You can change those defaults to check other domains.
Use dashboards to explore your resources
Dashboards use charts, tables, and interactive widgets to help you explore and visualize your resources. The AWS Insights mod, for example, provides dozens of dashboards that exercise the full set of widgets. To use these dashboards, first install the AWS plugin and authenticate. Then clone `AWS Insights`, change to its directory, launch `steampipe dashboard`, and open `localhost:9194`.
## Community We thrive on feedback and community involvement! **Have a question?** → Join our [Slack community](https://turbot.com/community/join?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) or open a [GitHub issue](https://github.com/turbot/steampipe/issues/new/choose). **Want to get involved?** → Learn how to [contribute](https://github.com/turbot/steampipe/blob/main/CONTRIBUTING.md). **Want to work with the team?** → We are [hiring](https://turbot.com/careers?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme)! ## Turbot Pipes Want a hosted version of Steampipe? Bring your team to [Turbot Pipes](https://pipes.turbot.com?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme).