2019-11-08 15:14:43 +03:00
# Go analysis support for CodeQL
2022-12-19 23:51:01 +03:00
This sub-folder contains the extractor, CodeQL libraries, and queries that power Go
support for CodeQL.
2019-11-08 15:14:43 +03:00
It contains two major components:
- an extractor, itself written in Go, that parses Go source code and converts it into a database
that can be queried using CodeQL.
2021-11-01 13:43:24 +03:00
- static analysis libraries and queries written in [CodeQL ](https://codeql.github.com/docs/ ) that can be
2019-11-08 15:14:43 +03:00
used to analyze such a database to find coding mistakes or security vulnerabilities.
## Usage
2020-05-29 08:38:23 +03:00
To analyze a Go codebase, either use the [CodeQL command-line
2021-10-30 00:17:17 +03:00
interface](https://codeql.github.com/docs/codeql-cli/) to create a database yourself, or
2023-02-02 22:11:02 +03:00
download a pre-built database from [GitHub.com ](https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-databases#downloading-databases-from-githubcom ). You can then run any of the
2020-05-29 08:38:23 +03:00
queries contained in this repository either on the command line or using the VS Code extension.
2019-11-08 15:14:43 +03:00
## Contributions
Contributions are welcome! Please see our [contribution guidelines ](CONTRIBUTING.md ) and our
[code of conduct ](CODE_OF_CONDUCT.md ) for details on how to participate in our community.
## Licensing
The code in this repository is licensed under the [MIT license ](LICENSE ).
## Resources
2021-10-30 00:17:17 +03:00
- [Writing CodeQL queries ](https://codeql.github.com/docs/writing-codeql-queries/codeql-queries/ )
- [Learning CodeQL ](https://codeql.github.com/docs/writing-codeql-queries/ql-tutorials/ )