CodeQL Pack¶

First lets import and download the codeql/python-queries pack with the version set to 0.8.0. This will automatically download the pack for us.

from ghastoolkit import CodeQLPack, CodeQLPacks

pack = CodeQLPack.download("codeql/python-queries", "0.8.0")
print(f"Pack :: {pack}")

Otherwise you can load via a path

pack = CodeQLPack("~/.codeql/packages/codeql/python-queries/0.8.0")
print(f"Pack :: {pack}")

Or load a collection of packs using the CodeQLPacks API.

packs = CodeQLPacks("~/.codeql/packages")
print(f"Packs :: {len(packs)}")
for pack in packs:
    print(f" -> {pack}")

Custom Packs¶

If you are creating custom packs and want to do all the things, you can use the easy to use APIs to make your life easier.

To resolve and install the pack dependencies, you can use the following:

pack.install()

To create a pack and install it locally on the current system:

path = pack.create()
print(f"Pack Install Path :: {path}")

To get a list of all the queries in the pack you can use the resolveQueries() API.

queries = pack.resolveQueries()
print(f"# Queries :: {len(queries)}")
for query in queries:
    print(f" - {query}")