pack init
Initializes a qlpack in the specified directory.
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 pack init [--dir=<dir>] [--extractor=<extractor>] <options>... -- <package-name>
codeql pack init [--dir=<dir>] [--extractor=<extractor>] <options>... -- <package-name>Description
Initializes a qlpack in the specified directory.
The pack will be created in a child directory of the specifieddirectory.
Available sincev2.6.0.
Options
Primary Options
<package-name>
[Mandatory] The scope and name of the pack to create. Scope is onlyrequired 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 workingdirectory.
-e, --extractor=<extractor>
The extractor to use for this qlpack. Only useful if this pack containstests.
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.