注意:本文已于 2023 年 1 月从 CodeQL 文档网站迁移。
关于 CodeQL CLI
软件开发人员和安全研究人员可以使用 CodeQL CLI 来保护其代码。
CodeQL CLI 是一种命令行工具,用于在开放源代码软件项目上本地运行 CodeQL 进程。 可以使用 CodeQL CLI 来执行以下操作:
- 使用 GitHub 工程师和开放源代码社区提供的查询运行 CodeQL 分析
- 创建 CodeQL 数据库以用于 Visual Studio Code 的 CodeQL
- 开发和测试自定义 CodeQL 查询,以用于你自己的分析
有关使用 CodeQL CLI 的信息,请参阅“CodeQL CLI 入门”。
关于 GitHub CodeQL 许可证
许可证通知: 如果没有 GitHub Enterprise 许可证,则通过安装此产品,即表示你同意 GitHub CodeQL 条款和条件。
GitHubCodeQL 按用户授予许可。 根据许可证限制,可以使用 CodeQL 执行以下任务:
- 执行学术研究。
- 演示软件。
- 测试根据 OSI 批准的许可证发布的 CodeQL 查询,确认这些查询的新版本可以继续找到正确的漏洞。
其中“OSI 批准的许可证”是指开放源代码计划 (OSI) 批准的开放源代码软件许可证。
如果使用的是开放源代码代码库(即根据 OSI 批准的许可证发布的代码库),则还可以使用 CodeQL 来完成以下任务:
- 对开放源代码代码库执行分析。
- 如果在 GitHub.com 上托管和维护开放源代码库,则为自动分析、持续集成或持续交付期间生成 CodeQL 数据库。
CodeQL 不能用于自动分析、持续集成或持续交付,无论是用作正常软件工程流程还是其他,除非在本文中明确说明。 对于这些用途,请联系销售团队。
CodeQL CLI 命令
CodeQL CLI 包括用于从命令行创建和分析 CodeQL 数据库的命令。 若要运行命令,请使用:
codeql [command] [subcommand]
若要查看命令的参考文档,请添加 --help
标志,或访问“CodeQL CLI 手册”。