> For the complete documentation index, see [llms.txt](https://ir0nstone.gitbook.io/notes/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ir0nstone.gitbook.io/notes/misc/codeql.md).

# CodeQL

Querying code to find vulnerabilities

## Overview

CodeQL is a static analysis engine that can automate finding security vulnerabilities and quality issues in code. As a tool, it provides us with the capacity to to identify vulnerabilities through pattern-matching.

CodeQL is more powerful than something simple like regex, as it abstracts away the quirks of the language itself and generates a database of functions, variables, control flow, etc. The idea is that once we identify a vulnerability we can craft a query that would pick up that vulnerability and perhaps make us aware of similar code in other parts of a large, unwieldy codebase. The crafted queries (which can include many out-of-the-box ones) are automatically run on a pull request and often implemented as part of a CI/CD pipeline.&#x20;

GitHub owns CodeQL, and if you are interested in learning more you can check out their introduction [here](https://codeql.github.com/docs/codeql-overview/about-codeql/).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://ir0nstone.gitbook.io/notes/misc/codeql.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
