Repository files navigation

StackQL is an open-source project built with Golang that allows you to create, modify and query the state of services and resources across different local and remote interfaces, using SQL semantics. Such interfaces canonically include, but are not limited to, cloud and SaaS providers (Google, AWS, Azure, Okta, GitHub, etc.).

StackQL is a standalone application that can be used in client mode (viaexec orshell) or accessed via a Postgres wire protocol client (psycopg2, etc.) using server mode (srv).

StackQL parses SQL statements and transpiles them into API requests to the (cloud) resource provider. The API calls are then executed and the results are returned to the user.

StackQL provider interfaces are canonically defined in OpenAPI extensions to the providers' specification. These definitions are then used to generate the SQL schema and the API client. The source for the provider definitions are stored in theStackQL Registry. The semantics of provider interactions are defined inourany-sdk library. For more detail on nuts and bolts, please seethe localAGENTS.md file andthat ofany-sdk.

flowchart LR  subgraph StackQL    direction BT    subgraph ProviderDefs        Registry[Provider Registry Docs]        end    subgraph App        Proc[$ stackql exec\n$ stackql shell\n$ stackql srv]        style Proc fill:#000,stroke:#000,color:#fff,text-align:left;        %% ,font-family:'Courier New', Courier, monospace    end  end  User((User)) <--> StackQL <--> Provider[Cloud Provider API]  ProviderDefs --> App

StackQL is available for Windows, MacOS, Linux, Docker, GitHub Actions and more. See the installation instructions below for your platform.

docker pull stackql/stackql

StackQL can be used via the interactive REPL shell, or via theexec command or ran as a server using thePostgres wire protocol.

ℹ️ StackQL does not require or install a database.

• Interactive Shell

  # run interactive stackql queriesstackql shell --auth="${AUTH}"

• Execute a statement or file

  stackqlexec --auth="${AUTH}" -i myscript.iql --iqldata vars.jsonnet --output json# orstackqlexec --auth="${AUTH}""SELECT id, status FROM aws.ec2.instances WHERE region = 'us-east-1'"

  ℹ️ output options ofjson,csv,table andtext are available for theexec command using the--output flag

  ℹ️ StackQL supports passing parameters usingjsonnet orjson, seeUsing Variables

• Server

  # serve client requests over the Postgres wire protocol (psycopg2, etc.)stackql srv --auth="${AUTH}"

For more examples, please check ourBlog

Contributions are welcome and encouraged. For more information on how to contribute, please see ourcontributing guide.

Distributed under the MIT License. SeeLICENSE for more information. Licenses for third party software we are using are included in the/docs/licenses directory.

Get in touch with us via Twitter at@stackql, email us atinfo@stackql.io or start a conversation usingdiscussions.

Forks of the following support our work:

• vitess
• kin-openapi
• gorilla/mux
• readline
• psql-wire
• mcp-postgres
• thegolang MCP SDK
• ...and more. Please excuse us for any omissions.

We gratefully acknowledge these pieces of work.