This content describes the most recent release of the CodeQL CLI. For more information about this release, see https://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 pack init [--dir=<dir>] [--extractor=<extractor>] <options>... -- <package-name>
Description
[Experimental] Initializes a qlpack in the specified directory.
The pack will be created in a child directory of the specified directory.
Available since v2.6.0
.
Primary options
<package-name>
[Mandatory] The scope and name of the pack to create. Scope is only required if this pack is to be published.
--version=<semver>
Initial version of the pack.
-d, --dir=<dir>
The directory to create the pack in. Defaults to current working directory.
-e, --extractor=<extractor>
The extractor to use for this qlpack. Only useful if this pack contains tests.
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 -v
and -q
.
--logdir=<dir>
[Advanced] Write detailed logs to one or more files in the given directory, with generated names that include timestamps and the name of the running subcommand.
(To write a log file with a name you have full control over, instead
give --log-to-stderr
and redirect stderr as desired.)