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
What is this?This is the standard library and query collection for CodeQL, the code analysis engine that powers GitHub Advanced Security code scanning and GitHub's commercial security products.
Is this the CodeQL engine itself, or just the queries?Just the libraries and queries written in the QL language. The actual CodeQL CLI and analysis engine live in a separate repository with a separate license.
How do I start writing and running queries?Install the CodeQL for Visual Studio Code extension for syntax highlighting, IntelliSense, and code navigation, then follow GitHub's documentation on the CodeQL language and CLI.
Do I need the CodeQL CLI separately?Yes, this repo only has the libraries and queries; you need the separately-hosted CodeQL CLI to actually run them.
Can I use this freely on any codebase, including closed-source?The libraries here are MIT licensed, but analyzing closed-source code with the CodeQL CLI requires a separate commercial license from GitHub.
What is QL / CodeQL's query language?QL is the custom query language used to write CodeQL libraries and queries; the README points to extensive documentation for learning it and the VS Code extension adds language support for it.
Are there built-in VS Code tasks for this repo?Yes, the repo includes a .vscode/tasks.json defining custom tasks you can run via the Terminal > Run Task menu or the command palette.
What are similar projects?mantis, VulnHunter, 0, codex-security, defending-code-reference-harness, Myrqen, shannon, DVWA
Which topics is it in?application-security, code-analysis, devsecops, vulnerability-scanner, code-review, static-analysis, penetration-testing, cybersecurity, security-tools, security, library, developer-tools
Creator
github
Size
523.4 MB
Stars
10.2K
Updated
CommitOct 16
Age
8y
Commits · 90 Days