{"id":21262844,"url":"https://github.com/stackql/setup-stackql","last_synced_at":"2026-03-15T01:02:05.512Z","repository":{"id":65669526,"uuid":"586773499","full_name":"stackql/setup-stackql","owner":"stackql","description":"Sets up the stackql cli in your GitHub Actions workflow.","archived":false,"fork":false,"pushed_at":"2024-10-28T21:25:30.000Z","size":353,"stargazers_count":7,"open_issues_count":4,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-28T22:26:34.116Z","etag":null,"topics":["cspm","infrastructure-as-code","sql","stackql"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stackql.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"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}},"created_at":"2023-01-09T07:41:01.000Z","updated_at":"2024-10-28T21:25:34.000Z","dependencies_parsed_at":"2024-04-28T22:31:11.131Z","dependency_job_id":"cbd5a244-643a-4c0e-a778-f9ce1b2d68f1","html_url":"https://github.com/stackql/setup-stackql","commit_stats":{"total_commits":164,"total_committers":3,"mean_commits":"54.666666666666664","dds":0.3109756097560976,"last_synced_commit":"4d2f157f4d9a6762d54acdeaa5c3e19d3929eb09"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fsetup-stackql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fsetup-stackql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fsetup-stackql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fsetup-stackql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackql","download_url":"https://codeload.github.com/stackql/setup-stackql/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225674897,"owners_count":17506272,"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":["cspm","infrastructure-as-code","sql","stackql"],"created_at":"2024-11-21T04:59:31.066Z","updated_at":"2026-03-15T01:02:05.483Z","avatar_url":"https://github.com/stackql.png","language":"JavaScript","readme":"[![Setup StackQL](https://github.com/stackql/setup-stackql/actions/workflows/setup-stackql-test.yml/badge.svg)](https://github.com/stackql/setup-stackql/actions/workflows/setup-stackql-test.yml)  \n\n# setup-stackql\n\nThe `stackql/setup-stackql` action is a JavaScript action that sets up StackQL CLI in your GitHub Actions workflow by downloading a latest Stackql CLI and adding it to the `PATH`.\n\nThis action can be run on `ubuntu-latest`, `windows-latest`, and `macos-latest` GitHub Actions runners, and will install and expose the latest version of the `stackql` CLI on the runner environment.  \n\n## Usage\nAuthentication to StackQL providers is done via environment variables source from GitHub Actions Secrets.  To learn more about authentication, see the setup instructions for your provider or providers at the [StackQL Provider Registry Docs](https://stackql.io/registry).\n\n## Examples\nThe following example demonstrate the use of the `stackql/setup-stackql` action in a GitHub Actions workflow, demonstrating how to use the action to install the `stackql` CLI and then use it to execute a StackQL query.\n\n### GitHub Example\nCheck the \"Use GitHub Provider\" step in [setup-stackql-test.yml](.github/workflows/setup-stackql-test.yml) for the working example, for more information on the GitHub provider for StackQL, see the [GitHub Provider Docs](https://github-provider.stackql.io/).\n\n```yaml\n    - name: setup StackQL\n      uses: stackql/setup-stackql@v2\n      with:\n        use_wrapper: true\n\n    - name: Use GitHub Provider\n      run: |\n        stackql exec -i ./examples/github-example.iql\n      env: \n        STACKQL_GITHUB_USERNAME: ${{  secrets.STACKQL_GITHUB_USERNAME }}\n        STACKQL_GITHUB_PASSWORD: ${{  secrets.STACKQL_GITHUB_PASSWORD }}\n```\n\n### Google Example\nCheck the \"Use Google Provider\" step in [setup-stackql-test.yml](.github/workflows/setup-stackql-test.yml) for the working example, for more information on the Google provider for StackQL, see the [Google Provider Docs](https://google-provider.stackql.io/).\n\n```yaml\n    - name: setup StackQL\n      uses: stackql/setup-stackql@v2\n      with:\n        use_wrapper: true\n\n    - name: Use Google Provider\n      run: | \n        stackql exec -i ./examples/google-example.iql\n      env: \n        GOOGLE_CREDENTIALS : ${{  secrets.GOOGLE_CREDENTIALS  }}\n```\n\n## Inputs\n- __`use_wrapper`__ - (optional) Whether to install a wrapper to wrap subsequent calls of\n   the `stackql` binary and expose its STDOUT, STDERR, and exit code as outputs\n   named `stdout`, `stderr`, and `exitcode` respectively. Defaults to `false`.\n\n## Outputs\nThis action does not configure any outputs directly. However, when you set the `use_wrapper` input\nto `true`, the following outputs are available for subsequent steps that call the `stackql` binary:\n\n- __`stdout`__ - The STDOUT stream of the call to the `stackql` binary.\n- __`stderr`__ - The STDERR stream of the call to the `stackql` binary.\n- __`exitcode`__ - The exit code of the call to the `stackql` binary.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackql%2Fsetup-stackql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackql%2Fsetup-stackql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackql%2Fsetup-stackql/lists"}