Repository files navigation

A starter workspace to use with theCodeQL extension for Visual Studio Code. For more information, see thevscode-codeql repo.

1. InstallVisual Studio Code.
2. Install theCodeQL extension for Visual Studio Code.
3. Clone this repository to your computer.
   • Make sure to include the submodules, either bygit clone --recursive or bygit submodule update --init --remote after clone.
   • Usegit submodule update --remote regularly to keep the submodules up to date.
4. In VS Code, click File > Open Workspace. Select the filevscode-codeql-starter.code-workspace in your checkout of this repository.
5. You will see several folders open in the left sidebar:
   • Theql folder contains theopen-source CodeQL standard libraries for C/C++, C#, Go, Java, JavaScript/Typescript, Python, and Ruby. It tracks the branch taggedcodeql-cli/latest inhttps://github.com/github/codeql. You can run the standard queries from here, and browse the libraries.
   • The folders namedcodeql-custom-queries-<language> are ready for you to start developing your own custom queries for each language, while using the standard libraries. There are some example queries to get you started.
6. Follow thedocumentation for the CodeQL extension to learn how to set up the extension, add a database and run queries against it. Have fun!

If you want to privately share your CodeQL queries with your teammates using this project as a template:

1. Create an empty, private project in the organization you want.
2. Clone this project locally:git clone git@github.com:github/vscode-codeql-starter.git
3. Add a remote to the local copygit remote add my-org git@github.com:<MY-ORG>/vscode-codeql-starter.git
4. Push the code to the new remote:git push my-org main

GitHub does not allow private forks of public repositories.

This project welcomes contributions. SeeCONTRIBUTING.md for details.

Issues and suggestions should be reported in thevscode-codeql repo.

This project islicensed under the MIT License.

The CodeQL extension for Visual Studio Code islicensed under the MIT License. The version of CodeQL used by the CodeQL extension is subject to theGitHub CodeQL Terms & Conditions.