resolve extensions-by-pack
[Experimental] [Deep plumbing] Determine accessible extensions forthe given paths to pack roots. This includes machine learning models anddata extensions.
Who can use this feature?
CodeQL is available for the following repository types:
- Public repositories on GitHub.com, seeGitHub CodeQL Terms and Conditions
- Organization-owned repositories on GitHub Team withGitHub Code Security enabled
In this article
Note
This content describes the most recent release of the CodeQL CLI. For more information about this release, seehttps://github.com/github/codeql-cli-binaries/releases.
To see details of the options available for this command in an earlier release, run the command with the--help option in your terminal.
Synopsis
codeql resolve extensions-by-pack <options>... -- <pack>...
codeql resolve extensions-by-pack <options>... -- <pack>...Description
[Deep plumbing] Determine accessible data extensions for the givenpaths to pack roots.
This plumbing command resolves the set of data extensions that areavailable to the paths passed in as command line arguments.
Available sincev2.13.3.
Options
Primary Options
<pack>...
The path to the root of the packs to resolve extensions for.
--search-path=<dir>[:<dir>...]
A list of directories under which QL packs may be found. Each directorycan either be a QL pack (or bundle of packs containing a.codeqlmanifest.json file at the root) or the immediate parent of oneor more such directories.
If the path contains more than one directory, their order definesprecedence between them: when a pack name that must be resolved ismatched in more than one of the directory trees, the one given firstwins.
Pointing this at a checkout of the open-source CodeQL repository oughtto work when querying one of the languages that live there.
If you have checked out the CodeQL repository as a sibling of theunpacked CodeQL toolchain, you don't need to give this option; suchsibling directories will always be searched for QL packs that cannot befound otherwise. (If this default does not work, it is stronglyrecommended to set up--search-path once and for all in a per-userconfiguration file).
(Note: On Windows the path separator is;).
--additional-packs=<dir>[:<dir>...]
If this list of directories is given, they will be searched for packsbefore the ones in--search-path. The order between these doesn'tmatter; it is an error if a pack name is found in two different placesthrough this list.
This is useful if you're temporarily developing a new version of a packthat also appears in the default path. On the other hand, it isnotrecommended to override this option in a config file; some internalactions will add this option on the fly, overriding any configuredvalue.
(Note: On Windows the path separator is;).
--model-packs=<name@range>...
A list of CodeQL pack names, each with an optional version range, to beused as model packs to customize the queries that are about to beevaluated.
--threat-model=<name>...
A list of threat models to enable or disable.
The argument is the name of a threat model, optionally preceded by a'!'. If no '!' is present, the named threat model and all of itsdescendants are enabled. If a '!' is present, the named threat modeland all of its descendants are disabled.
The 'default' threat model is enabled by default, but can be disabledby specifying '--threat-model !default'.
The 'all' threat model can be used to enable or disable all threatmodels.
The --threat-model options are processed in order. For example,'--threat-model local --threat-model !environment' enables all ofthe threat models in the 'local' group except for the 'environment'threat model.
This option only has an effect for languages that support threat models.
Available sincev2.15.3.
Options for configuring the CodeQL package manager
--registries-auth-stdin
Authenticate to GitHub Enterprise Server Container registries by passinga comma-separated list of <registry_url>=<token> pairs.
For example, you can passhttps://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2to authenticate to two GitHub Enterprise Server instances.
This overrides the CODEQL_REGISTRIES_AUTH and GITHUB_TOKEN environmentvariables. If you only need to authenticate to the github.com Containerregistry, you can instead authenticate using the simpler--github-auth-stdin option.
--github-auth-stdin
Authenticate to the github.com Container registry by passing agithub.com GitHub Apps token or personal access token via standardinput.
To authenticate to GitHub Enterprise Server Container registries, pass--registries-auth-stdin or use the CODEQL_REGISTRIES_AUTH environmentvariable.
This overrides the GITHUB_TOKEN environment variable.
Common options
-h, --help
Show this help text.
-J=<opt>
[Advanced] Give option to the JVM running the command.
(Beware that options containing spaces will not be handled correctly.)
-v, --verbose
Incrementally increase the number of progress messages printed.
-q, --quiet
Incrementally decrease the number of progress messages printed.
--verbosity=<level>
[Advanced] Explicitly set the verbosity level to one of errors,warnings, progress, progress+, progress++, progress+++. Overrides-vand-q.
--logdir=<dir>
[Advanced] Write detailed logs to one or more files in the givendirectory, with generated names that include timestamps and the name ofthe running subcommand.
(To write a log file with a name you have full control over, insteadgive--log-to-stderr and redirect stderr as desired.)
--common-caches=<dir>
[Advanced] Controls the location of cached data on disk that willpersist between several runs of the CLI, such as downloaded QL packs andcompiled query plans. If not set explicitly, this defaults to adirectory named.codeql in the user's home directory; it will becreated if it doesn't already exist.
Available sincev2.15.2.