{"id":13819654,"url":"https://github.com/stackql/stackql","last_synced_at":"2025-04-04T22:07:44.679Z","repository":{"id":37019875,"uuid":"443987542","full_name":"stackql/stackql","owner":"stackql","description":"Query, provision and operate Cloud and SaaS resources and APIs using an extensible SQL based framework","archived":false,"fork":false,"pushed_at":"2024-04-24T21:56:01.000Z","size":17762,"stargazers_count":435,"open_issues_count":106,"forks_count":44,"subscribers_count":11,"default_branch":"main","last_synced_at":"2024-05-01T11:44:48.203Z","etag":null,"topics":["asset-management","cloud","cloud-automation","cloud-config","cloud-operations","cloud-security","cspm","devops","devsecops","hacktoberfest","infrastructure-as-code","openapi3","sql","stackql"],"latest_commit_sha":null,"homepage":"https://stackql.io/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stackql.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stackql"]}},"created_at":"2022-01-03T08:20:06.000Z","updated_at":"2024-08-07T23:00:21.097Z","dependencies_parsed_at":"2024-04-21T09:49:13.522Z","dependency_job_id":"f580b80a-1fb1-44c9-a4c3-bf8a8b236aca","html_url":"https://github.com/stackql/stackql","commit_stats":{"total_commits":271,"total_committers":15,"mean_commits":"18.066666666666666","dds":0.2583025830258303,"last_synced_commit":"0bd28150fde321ff4d9771503812bb50c58f752d"},"previous_names":[],"tags_count":159,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackql","download_url":"https://codeload.github.com/stackql/stackql/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247119035,"owners_count":20886675,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asset-management","cloud","cloud-automation","cloud-config","cloud-operations","cloud-security","cspm","devops","devsecops","hacktoberfest","infrastructure-as-code","openapi3","sql","stackql"],"created_at":"2024-08-04T08:00:51.267Z","updated_at":"2025-04-04T22:07:44.652Z","avatar_url":"https://github.com/stackql.png","language":"Go","readme":"\u003c!-- web assets --\u003e\n[logo]: https://stackql.io/img/stackql-logo-bold.png \"stackql logo\"\n[homepage]: https://stackql.io/\n[docs]: https://stackql.io/docs\n[blog]: https://stackql.io/blog\n[registry]: https://github.com/stackql/stackql-provider-registry\n[variables]: https://stackql.io/docs/getting-started/variables\n[macpkg]: https://storage.googleapis.com/stackql-public-releases/latest/stackql_darwin_multiarch.pkg\n[winmsi]: https://releases.stackql.io/stackql/latest/stackql_windows_amd64.msi\n[winzip]: https://releases.stackql.io/stackql/latest/stackql_windows_amd64.zip\n[tuxzip]: https://releases.stackql.io/stackql/latest/stackql_linux_amd64.zip\n\u003c!-- docker links --\u003e\n[dockerhub]: https://hub.docker.com/u/stackql\n[dockerstackql]: https://hub.docker.com/r/stackql/stackql\n[dockerjupyter]: https://hub.docker.com/r/stackql/stackql-jupyter-demo\n\u003c!-- github actions links --\u003e\n[setupaction]: https://github.com/marketplace/actions/stackql-studios-setup-stackql\n[execaction]: https://github.com/marketplace/actions/stackql-studios-stackql-exec\n\u003c!-- badges --\u003e\n[badge1]: https://img.shields.io/badge/platform-windows%20macos%20linux-brightgreen \"Platforms\"\n[badge2]: https://github.com/stackql/stackql/workflows/Go/badge.svg \"Go\"\n[badge3]: https://img.shields.io/github/license/stackql/stackql \"License\"\n[badge4]: https://img.shields.io/tokei/lines/github/stackql/stackql \"Lines\"    \n\u003c!-- github links --\u003e\n[issues]: https://github.com/stackql/stackql/issues/new?assignees=\u0026labels=bug\u0026template=bug_report.md\u0026title=%5BBUG%5D\n[features]: https://github.com/stackql/stackql/issues/new?assignees=\u0026labels=enhancement\u0026template=feature_request.md\u0026title=%5BFEATURE%5D\n[developers]: /docs/developer_guide.md\n[registrycont]: /docs/registry_contribution.md\n[designdocs]: /docs/high-level-design.md\n[contributing]: /CONTRIBUTING.md\n[discussions]: https://github.com/orgs/stackql/discussions\n\u003c!-- repo assets --\u003e\n[darkmodeterm]: /docs/images/stackql-light-term.gif#gh-dark-mode-only\n[lightmodeterm]: /docs/images/stackql-dark-term.gif#gh-light-mode-only\n\u003c!-- misc links --\u003e\n[twitter]: https://twitter.com/stackql\n\n\u003c!-- language: lang-none --\u003e\n\u003cdiv align=\"center\"\u003e\n\n[![logo]][homepage]  \n![badge1]\n![badge2]\n![badge3]\n![badge4]\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n![homebrew downloads](https://img.shields.io/homebrew/installs/dy/stackql?label=homebrew%20downloads)\n![homebrew version](https://img.shields.io/homebrew/v/stackql?label=homebrew%20version)\n![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/stackql/stackql/total?label=github%20release%20downloads)\n![GitHub Release](https://img.shields.io/github/v/release/stackql/stackql?label=github%20release)\n![Docker Pulls](https://img.shields.io/docker/pulls/stackql/stackql)\n![Docker Image Version](https://img.shields.io/docker/v/stackql/stackql?label=docker%20version)\n![Chocolatey Downloads](https://img.shields.io/chocolatey/dt/stackql?label=chocolatey%20downloads)\n![Chocolatey Version](https://img.shields.io/chocolatey/v/stackql)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/stackql-deploy?label=pypi%20downloads)\n\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n\n### Deploy, manage and query cloud resources and interact with APIs using SQL\n\u003c!-- \u003ch3 align=\"center\"\u003eSQL based XOps, observability and middleware framework\u003c/h3\u003e --\u003e\n\n\u003cp align=\"center\"\u003e\n\n[__Read the docs »__][docs]  \n[Raise an Issue][issues] · \n[Request a Feature][features] · \n[Developer Guide][developers] · \n[BYO Providers][registrycont]\n\n\u003c/p\u003e\n\u003c/div\u003e\n\n\u003cdetails open=\"open\"\u003e\n\u003csummary\u003eContents\u003c/summary\u003e\n\u003col\u003e\n\u003cli\u003e\u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n\u003c!-- \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e --\u003e\n\u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href=\"#acknowledgements\"\u003eAcknowledgements\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003c/details\u003e\n\n## About The Project\n\n[__StackQL__][homepage] is an open-source project built with Golang that allows you to create, modify and query the state of services and resources across different cloud and SaaS providers (Google, AWS, Azure, Okta, GitHub, etc.) using SQL semantics\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n![stackql-shell][darkmodeterm]\n![stackql-shell][lightmodeterm]\n\n### How it works\n\nStackQL is a standalone application that can be used in client mode (via __`exec`__ or __`shell`__) or accessed via a Postgres wire protocol client (`psycopg2`, etc.) using server mode (__`srv`__).  \n\nStackQL parses SQL statements and transpiles them into API requests to the cloud provider.  The API calls are then executed and the results are returned to the user.  \n\nStackQL provider definitions are 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 the [__StackQL Registry__][registry].  \n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eStackQL Context Diagram\u003c/b\u003e\u003c/summary\u003e\n\u003cbr /\u003e\nThe following context diagram describes the StackQL architecture at a high level:  \n\n\u003c!-- ![StackQL Context Diagram](http://www.plantuml.com/plantuml/proxy?cache=no\u0026src=https://raw.githubusercontent.com/stackql/test-readme/main/puml/stackql-c4-context.iuml) --\u003e\n\n```mermaid\nflowchart LR\n  subgraph StackQL\n    direction BT\n    subgraph ProviderDefs\n        Registry[Provider Registry Docs]    \n    end\n    subgraph App\n        Proc[$ stackql exec\\n$ stackql shell\\n$ stackql srv]\n        style Proc fill:#000,stroke:#000,color:#fff,text-align:left;\n\n        %% ,font-family:'Courier New', Courier, monospace\n    end\n  end\n  User((User)) \u003c--\u003e StackQL \u003c--\u003e Provider[Cloud Provider API]\n  ProviderDefs --\u003e App\n```\n\nMore detailed design documentation can be found in the [here][designdocs].\n\n\u003c/details\u003e\n\n## Installation\n\nStackQL is available for Windows, MacOS, Linux, Docker, GitHub Actions and more.  See the installation instructions below for your platform.  \n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eInstalling on MacOS\u003c/b\u003e\u003c/summary\u003e\n\n- Homebrew (`amd64` and `arm64`)\n  - `brew install stackql` *or* `brew tap stackql/tap \u0026\u0026 brew install stackql/tap/stackql`\n- MacOS PKG Installer (`amd64` and `arm64`)\n  - download the latest [MacOS PKG installer for StackQL][macpkg]\n  - run the installer and follow the prompts\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eInstalling on Windows\u003c/b\u003e\u003c/summary\u003e\n\n- MSI Installer\n  - download the latest [MSI installer for StackQL][winmsi]\n  - run the installer and follow the prompts\n- Chocolatey\n  - install [Chocolatey](https://chocolatey.org/install)\n  - run `choco install stackql`\n- ZIP Archive\n  - download the latest [Windows ZIP archive for StackQL][winzip]\n  - extract the archive (code signed `stackql.exe` file) to a directory of your choice\n  - add the directory to your `PATH` environment variable (optional)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eInstalling on Linux\u003c/b\u003e\u003c/summary\u003e\n\n- ZIP Archive\n  - download the latest [Linux ZIP archive for StackQL][tuxzip]\n    - or via `curl -L https://bit.ly/stackql-zip -O \u0026\u0026 unzip stackql-zip`\n  - extract the archive (`stackql` file) to a directory of your choice\n  - add the directory to your `PATH` environment variable (optional)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eGetting StackQL from DockerHub\u003c/b\u003e\u003c/summary\u003e\n\n\u003e View all available StackQL images on [__DockerHub__][dockerhub].  Images available include [__`stackql`__][dockerstackql], [__`stackql-jupyter-demo`__][dockerjupyter] and more.  Pull the latest StackQL base image using:  \n\n```bash\ndocker pull stackql/stackql\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eUsing StackQL with GitHub Actions\u003c/b\u003e\u003c/summary\u003e\n\n\u003e Use StackQL in your GitHub Actions workflows to automate cloud infrastructure provisioning, IaC assurance, or compliance/security.  Available GitHub Actions include: [`setup-stackql`][setupaction], [`stackql-exec`][execaction] and more\n\n\u003c/details\u003e\n\n## Usage\n\nStackQL can be used via the interactive REPL shell, or via the `exec` command or ran as a server using the [Postgres wire protocol](https://www.postgresql.org/docs/current/protocol.html).  \n\n\u003e ℹ️ StackQL does not require or install a database.\n\n* Interactive Shell\n  ```sh\n  # run interactive stackql queries\n  stackql shell --auth=\"${AUTH}\"\n  ```\n* Execute a statement or file\n  ```sh\n  stackql exec --auth=\"${AUTH}\" -i myscript.iql --iqldata vars.jsonnet --output json\n  \n  # or\n  \n  stackql exec --auth=\"${AUTH}\" \"SELECT id, status FROM aws.ec2.instances WHERE region = 'us-east-1'\"\n  ```\n\n  \u003e ℹ️ output options of `json`, `csv`, `table` and `text` are available for the `exec` command using the `--output` flag\n\n  \u003e ℹ️ StackQL supports passing parameters using `jsonnet` or `json`, see [__Using Variables__][variables]\n* Server\n  ```sh\n  # serve client requests over the Postgres wire protocol (psycopg2, etc.) \n  stackql srv --auth=\"${AUTH}\"\n  ```\n\n_For more examples, please check our [Blog][blog]_\n\n\u003c!-- ## Roadmap\n\nSee our [__roadmap__](https://github.com/othneildrew/Best-README-Template/issues) to see where we are going with the project. --\u003e\n\n## Contributing\n\nContributions are welcome and encouraged.  For more information on how to contribute, please see our [__contributing guide__][contributing].\n\n## License\n\nDistributed under the MIT License. See [`LICENSE`](https://github.com/stackql/stackql/blob/main/LICENSE) for more information.  Licenses for third party software we are using are included in the [/docs/licenses](/docs/licenses) directory.\n\n## Contact\n\nGet in touch with us via Twitter at [__@stackql__][twitter], email us at [__info@stackql.io__](info@stackql.io) or start a conversation using [__discussions__][discussions].\n\n## Acknowledgements\nForks of the following support our work:\n\n* [vitess](https://vitess.io/)\n* [kin-openapi](https://github.com/getkin/kin-openapi)\n* [gorilla/mux](https://github.com/gorilla/mux)\n* [readline](https://github.com/chzyer/readline)\n* [psql-wire](https://github.com/jeroenrinzema/psql-wire)\n\nWe gratefully acknowledge these pieces of work.\n\n","funding_links":["https://github.com/sponsors/stackql"],"categories":["Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackql%2Fstackql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackql%2Fstackql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackql%2Fstackql/lists"}