codeql README

The project's README from github.com/github/codeql. As one markdown file: README.md.

CodeQL

This open source repository contains the standard CodeQL libraries and queries that power GitHub Advanced Security and the other application security products that GitHub makes available to its customers worldwide.

How do I learn CodeQL and run queries?

There is extensive documentation about the CodeQL language, writing CodeQL using the CodeQL extension for Visual Studio Code and using the CodeQL CLI.

Contributing

We welcome contributions to our standard library and standard checks. Do you have an idea for a new check, or how to improve an existing query? Then please go ahead and open a pull request! Before you do, though, please take the time to read our contributing guidelines. You can also consult our style guides to learn how to format your code for consistency and clarity, how to write query metadata, and how to write query help documentation for your query.

For information on contributing to CodeQL documentation, see the "contributing guide" for docs.

License

The code in this repository is licensed under the MIT License by GitHub.

The CodeQL CLI (including the CodeQL engine) is hosted in a different repository and is licensed separately. If you'd like to use the CodeQL CLI to analyze closed-source code, you will need a separate commercial license; please contact us for further help.

Visual Studio Code integration

If you use Visual Studio Code to work in this repository, there are a few integration features to make development easier.

CodeQL for Visual Studio Code

You can install the CodeQL for Visual Studio Code extension to get syntax highlighting, IntelliSense, and code navigation for the QL language, as well as unit test support for testing CodeQL libraries and queries.

Tasks

The .vscode/tasks.json file defines custom tasks specific to working in this repository. To invoke one of these tasks, select the Terminal | Run Task... menu option, and then select the desired task from the dropdown. You can also invoke the Tasks: Run Task command from the command palette.

codeql (github/codeql)

Searching Database…

10.2K ·GitHub
这是什么?这是 CodeQL 的标准库和查询集合。CodeQL 是驱动 GitHub Advanced Security 代码扫描和 GitHub 商业安全产品的代码分析引擎。
这是 CodeQL 引擎本身,还是只是查询?只是用 QL 语言编写的库和查询。真正的 CodeQL CLI 和分析引擎在另一个仓库里,采用另外的许可证。
怎么开始编写和运行查询?安装 CodeQL for Visual Studio Code 扩展以获得语法高亮、IntelliSense 和代码导航,然后按照 GitHub 关于 CodeQL 语言和 CLI 的文档操作。
我需要单独安装 CodeQL CLI 吗?需要,这个仓库只有库和查询;要真正运行它们,你需要单独托管的 CodeQL CLI。
我可以在任何代码库(包括闭源代码)上自由使用它吗?这里的库采用 MIT 许可证,但用 CodeQL CLI 分析闭源代码需要 GitHub 的单独商业许可。
QL,也就是 CodeQL 的查询语言,是什么?QL 是用来编写 CodeQL 库和查询的自定义查询语言;README 提供了学习它的详尽文档链接,VS Code 扩展也为它添加了语言支持。
这个仓库有内置的 VS Code 任务吗?有,仓库包含一个 .vscode/tasks.json,定义了可通过 Terminal > Run Task 菜单或命令面板运行的自定义任务。
Creator
github
Size
523.4 MB
Stars
10.2K
Updated
CommitOct 16
Age
8y
Commits · 90 Days