{"id":13809707,"url":"https://github.com/github/gh-codeql","last_synced_at":"2025-10-11T19:33:36.244Z","repository":{"id":45634066,"uuid":"407100753","full_name":"github/gh-codeql","owner":"github","description":"GitHub CLI extension for working with CodeQL","archived":false,"fork":false,"pushed_at":"2025-02-14T05:45:55.000Z","size":39,"stargazers_count":32,"open_issues_count":2,"forks_count":12,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-24T17:06:59.115Z","etag":null,"topics":["gh-extension"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/github.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-09-16T09:20:24.000Z","updated_at":"2025-07-24T14:36:37.000Z","dependencies_parsed_at":"2024-03-23T03:25:50.507Z","dependency_job_id":"098b0247-8984-43f9-86ba-55191b99120f","html_url":"https://github.com/github/gh-codeql","commit_stats":{"total_commits":19,"total_committers":6,"mean_commits":"3.1666666666666665","dds":0.4736842105263158,"last_synced_commit":"e770713c8d14d0ea7641cebb5a688e8712131c3c"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/github/gh-codeql","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fgh-codeql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fgh-codeql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fgh-codeql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fgh-codeql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/github","download_url":"https://codeload.github.com/github/gh-codeql/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fgh-codeql/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279008424,"owners_count":26084460,"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","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["gh-extension"],"created_at":"2024-08-04T02:00:34.722Z","updated_at":"2025-10-11T19:33:36.230Z","avatar_url":"https://github.com/github.png","language":"Shell","readme":"# CodeQL extension for the [GitHub CLI](https://cli.github.com/)\n\nThis CLI extension exposes the [CodeQL CLI](https://codeql.github.com/docs/codeql-cli/) as a subcommand of the GitHub CLI, with some additional niceties such as version management. Like other extensions to the GitHub CLI, it is written in Bash.\n\n## Installation\n\nOnce you have installed the GitHub CLI (version 2.0 or higher), run:\n\n```bash\ngh extensions install github/gh-codeql\n```\n\n## Usage\n\n```bash\n$ gh codeql\nGitHub command-line wrapper for the CodeQL CLI.\n\nUsage:\n    gh codeql set-channel [release|nightly]     # default: release\n    gh codeql set-version [version]             # default: latest\n    gh codeql set-local-version [version]       # set the version for the current working directory, default: latest\n    gh codeql unset-local-version               # switch back to the global version\n    gh codeql list-versions                     # list all available versions for current channel\n    gh codeql list-installed                    # list installed versions for current channel\n    gh codeql cleanup \u003cversion\u003e                 # delete a specific downloaded version\n    gh codeql cleanup-all                       # delete all installed versions for all channels\n    gh codeql download [version]                # download a specific version (default: latest)\n    gh codeql debug [on|off]                    # enable/disable debug output for gh extension\n    gh codeql install-stub [dir]                # default: /usr/local/bin/\n    gh codeql \u003canything else\u003e                   # pass arguments to CodeQL CLI\n\nCurrent channel: release.\nCurrent version: not specified.\n```\n\nYou should be able to prefix any `codeql` command you run with `gh` to automatically download the selected version (by default: the latest release version at the time you first run it) and delegate to it.\n\n### Support\n\nThis extension is owned by the CodeQL team. If you have any problems or feature requests, please raise them in the [CodeQL repository](https://github.com/github/codeql).\n\n### Channels\n\nThere are two channels: \"release\" and \"nightly\". You are on the release channel by default, and switching channels unpins the selected version (meaning that, unless you run `gh codeql set-version`, the latest version of the current channel will be selected the next time you run a command).\n\nYou can list the versions available on the current channel with `gh codeql list-versions`.\n\nYou can list the installed versions from the current channel with `gh codeql list-installed`, and reclaim disk space with `gh codeql cleanup \u003cversion\u003e`. There is no automatic cleanup.\n\n### Versions\n\nThe `gh codeql` command always works relative to a pinned version on the current channel. You can manually specify the pinned version using `gh codeql set-version`. To pin a version to a working directory you can use the command `gh codeql set-local-version` and `gh codeql` will always use that version when running in that working directory. To remove a pin from a working directory run `gh codeql unset-local-version` in that working directory.\n\nYou can download additional versions without pinning them (perhaps to prepare for local comparisons) using `gh codeql download`.\n\nTo upgrade, run `gh codeql set-version latest`, which will pin you to the current latest version.\n\n### CodeQL stub\n\nIf you want to use the GitHub CLI managed CodeQL version directly in a terminal or use it with the Visual Studio Code CodeQL extension then you can install a stub using the command `gh codeql install-stub` that will install a Bash script called `codeql` that invokes the GitHub CLI. The default install directory is `/usr/local/bin/`, but you can change this by passing an existing directory.\n\n## Development\n\nThis extension is newly released and under active development. Contributions are very welcome, for more information about how you can contribute, please check our [CONTRIBUTING.md](CONTRIBUTING.md) file. For a list of outstanding issues, please take a look at [our backlog](https://github.com/github/gh-codeql/issues). If you encounter a problem that does not already have an open issue associated with it, please open one there.\n\n## Licensing\n\nThis extension is released by GitHub under the MIT License. For the full text of this, please consult our [LICENSE.md](LICENSE.md) file.\n\nNote that this license applies only to the extension in this repository, for more information on the license governing use of the CodeQL CLI that it uses, please consult the [GitHub CodeQL Terms and Conditions](https://securitylab.github.com/tools/codeql/license/). In particular, note that there are restrictions on how you may use the the CodeQL CLI on code that is not released under an OSI-approved open source software license.\n","funding_links":[],"categories":["gh-extension","🧩 Categories","CodeQL CLI Tooling"],"sub_categories":["Miscellaneous"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Fgh-codeql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgithub%2Fgh-codeql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Fgh-codeql/lists"}