Skip to main content

此版本的 GitHub Enterprise Server 已于以下日期停止服务 2024-09-25. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

安装适用于 Visual Studio Code 的 CodeQL

若要开始使用适用于 Visual Studio Code 的 CodeQL,需要安装和设置扩展。

谁可以使用此功能?

CodeQL 可用于以下存储库类型:

先决条件

CodeQL 扩展至少需要 Visual Studio Code 1.82.0。 不支持较旧的版本。

安装扩展

可以使用多种不同方法之一安装适用于 Visual Studio Code 的 CodeQL 扩展:

  • 在浏览器中使用 Visual Studio Code 市场。

  • 在 Visual Studio Code 中的“扩展”视图中搜索。

  • 使用 VSIX 文件。

使用 Visual Studio Code 市场

  1. 在浏览器中,转到 Visual Studio Code 市场中的“GitHub Copilot”

  2. 单击“安装”,然后按照屏幕上的提示进行操作。

在“扩展”视图中搜索

  1. 在 VS Code 中,打开“扩展”视图。

  2. 搜索“CodeQL”,然后单击“安装”。

使用 CodeQL VSIX 文件

  1. 从 GitHub 上的 github/vscode-codeql 存储库下载 CodeQL VSIX 文件

  2. 在 VS Code 中,打开“扩展”视图。

  3. 在边栏右上角,单击省略号,然后单击“从 VSIX 安装...”。

  4. 选择在步骤 1 中下载的 CodeQL VSIX 文件。

  5. 按照屏幕提示完成安装。

后续步骤

若要了解如何在扩展中使用 CodeQL 数据库,请参阅“管理 CodeQL 数据库”。

如果已找到、下载或创建了 CodeQL 数据库,则可以了解如何使用扩展对 CodeQL 数据库运行查询并查看结果。 有关详细信息,请参阅“运行 CodeQL 查询”。

若要了解如何配置随扩展一起安装的 CodeQL CLI 之外的其他版本的访问权限,请参阅“配置 CodeQL CLI 的访问权限”。

若要了解如何设置 CodeQL 工作区,请参阅“设置 CodeQL 工作区”。