github.com/turbot/steampipe@v1.7.0-rc.0.0.20240517123944-7cef272d4458/README.md (about) 1 [<picture><source media="(prefers-color-scheme: dark)" srcset="https://steampipe.io/images/steampipe-color-logo-and-wordmark-with-white-bubble.svg"><source media="(prefers-color-scheme: light)" srcset="https://steampipe.io/images/steampipe-color-logo-and-wordmark-with-white-bubble.svg"><img width="67%" alt="Steampipe Logo" src="https://steampipe.io/images/steampipe-color-logo-and-wordmark-with-white-bubble.svg"></picture>](https://steampipe.io?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) 2 3 [![plugins](https://img.shields.io/badge/apis_supported-140-blue)](https://hub.powerpipe.io/plugins?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) 4 [![slack](https://img.shields.io/badge/slack-2297-blue)](https://turbot.com/community/join?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) 5 [![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) 6 7 8 Steampipe is the zero-ETL solution for getting data directly from APIs and services. We offer these Steampipe engines: 9 10 - Steampipe CLI. Use the Steampipe core engine to translate APIs to tables in the Postgres instance that's bundled with Steampipe. 11 12 - Steampipe Postgres FDWs. Use [native Postgres Foreign Data Wrappers](https://steampipe.io/docs/steampipe_postgres/overview) to translate APIs to foreign tables. 13 14 - Steampipe SQLite extensions. Use [SQLite extensions](https://steampipe.io/docs/steampipe_sqlite/overview) to translate APIS to SQLite virtual tables. 15 16 - Steampipe export tools. Use [standalone binaries](https://steampipe.io/docs/steampipe_export/overview) that export data from APIs, no database required. 17 18 - Turbot Pipes. Use [Turbot Pipes](https://turbot.com/pipes) to run Steampipe in the cloud. 19 20 ## Steampipe API plugins 21 22 The Steampipe community has grown a suite of [plugins](https://hub.powerpipe.io/plugins?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme) that map APIs to database tables. They work with all Steampipe engines. 23 24 25 ## Install Steampipe 26 27 The <a href="https://steampipe.io/downloads?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme">downloads</a> page shows you how but tl;dr: 28 29 Linux or WSL 30 31 ```sh 32 sudo /bin/sh -c "$(curl -fsSL https://steampipe.io/install/steampipe.sh)" 33 ``` 34 35 MacOS 36 37 ```sh 38 brew tap turbot/tap 39 brew install steampipe 40 ``` 41 42 ## Install a plugin 43 44 Choose a plugin from the [hub](https://hub.powerpipe.io?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme), for example: [Hacker News](https://hub.powerpipe.io/plugins/turbot/hackernews?utm_id=gspreadme&utm_source=github&utm_medium=repo&utm_campaign=github&utm_content=readme). 45 46 Run the `steampipe plugin` command to install it. 47 48 ```sh 49 steampipe plugin install hackernews 50 ``` 51 52 ## Query with a plugin 53 54 Run a query using `psql` — or another Postgres client , or [Powerpipe](https://powerpipe.io) — to query a table provided by the installed plugin. 55 56 57 ``` 58 psql -h localhost -p 9193 -d steampipe -U steampipe 59 ``` 60 61 ``` 62 steampipe=> select * from hackernews_new limit 10 63 ``` 64 65 ## Developing 66 67 Prerequisites: 68 69 - [Golang](https://golang.org/doc/install) Version 1.19 or higher. 70 71 Clone the repo. 72 73 ```sh 74 git clone https://github.com/turbot/steampipe 75 cd steampipe 76 ``` 77 78 Build, which automatically installs the new version to your `/usr/local/bin/steampipe` directory: 79 80 ``` 81 make 82 ``` 83 84 Check the version. 85 86 ``` 87 $ steampipe -v 88 steampipe version 0.21.1 89 ``` 90 91 Install a plugin and run a query as per above. 92 93 ## Open source & contributing 94 95 This repository is published under the [AGPL 3.0](https://www.gnu.org/licenses/agpl-3.0.html) license. Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). Contributors must sign our [Contributor License Agreement](https://turbot.com/open-source#cla) as part of their first pull request. We look forward to collaborating with you! 96 97 [Steampipe](https://steampipe.io) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source). 98 99 ## Turbot Pipes 100 101 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). 102 103 ## Get involved 104 105 **[Join #steampipe on Slack →](https://turbot.com/community/join)** 106 107 Want to help but don't know where to start? Pick up one of the `help wanted` issues: 108 * [Steampipe](https://github.com/turbot/steampipe/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)