GitHubSecurityLab/codeql-jupyter-kernel

Jupyter Kernel for CodeQL

CodeQL kernel for Jupyter

A Jupyter kernel for executing CodeQL queries.

Requirements

• Jupyter
• CodeQL CLI binaries

Local Installation

To install from a git checkout, run:

$ pip install jupyter jupyterlab tree_sitter
$ make install

Verify installation:

Run jupyter kernelspec list and check that codeql is available as a Jupyter kernel:

$ jupyter kernelspec list      
Available kernels:
  codeql     /Users/pwntester/.pyenv/versions/3.8.13/share/jupyter/kernels/codeql
  python3    /Users/pwntester/.pyenv/versions/3.8.13/share/jupyter/kernels/python3

Highlight extension

Jupyter-lab extension to highlight CodeQL syntax

Local Installation

cd jupyterlab-codeql-highlight
npm install
jupyter labextension link .

Commands

• %set_database <CodeQL DB directory>: Sets the Database for analysis.

Example

cd example
jupyter-lab test.ipynb

Wait for each cell to run before running other cells.

Disclaimer

This is an experimental project not maintained by the GitHub CodeQL teams. Any contributions are welcomed!