Synopsis

codeql pack publish [--dry-run] [--threads=<num>] [--ram=<MB>] [--pack=<folder> | <package.tgz>] <options>... -- <dir>

codeql pack publish [--dry-run] [--threads=<num>] [--ram=<MB>] [--pack=<folder> | <package.tgz>] <options>... -- <dir>

Description

Publishes a QL library pack to a package registry.

This command publishes a pack to a package registry. Before publishing,the pack is first compiled (if necessary) and bundled.

Available sincev2.6.0.

Options

Primary Options

<dir>

The root directory of the package or workspace, defaults to the currentworking directory. If this parameter points to a directory containing aqlpack.yml, then this operation will run on only that CodeQL package. Ifthis parameter points to a directory containing a codeql-workspace.yml,then this operation will run on all CodeQL packages in the workspace.

-n, --[no-]dry-run

Print what would have been done, but do not actually publish thepackage.

--no-keep

Delete the pack bundle after publishing.

-j, --threads=<num>

Use this many threads to compile queries.

Defaults to 1. You can pass 0 to use one thread per core on the machine,or -N to leaveN cores unused (except still use at least onethread).

-M, --ram=<MB>

Set total amount of RAM that the compiler should be allowed to use.

--no-precompile

[Advanced] Avoid precompiling the compilation cache in the pack outputdirectory. This will reduce the size of the pack and the time it takesto create it, but will require compilation before the pack can be run.Only meaningful for query packs.

--no-validate-extensions

[Advanced] Avoid validating data extensions as part of the compilestep.

Available sincev2.13.3.

--no-overwrite

[Advanced] Avoid recompiling and overwriting any existing compiledoutput from a previous invocation of this command.

-p, --pack=<folder> | <package.tgz>

[Advanced] The location to place the packaged tarball. If this optionends in .tgz, then the tarball will be created with that name.Otherwise, a new directory is created at the specified path and one ormore tarballs are created there. Using .tgz is not allowed forworkspaces.

--file=<package.tgz>

[Advanced] Uploadpackage.tgz directly to the package registrywithout trying to create or bundle anything new.

--[no-]allow-prerelease

Allow packs with pre-release version qualifiers (e.g.,X.Y.Z-qualifier) to be used. Without this flag, pre-release packs willbe ignored.

Available sincev2.11.3.

Options for configuring which CodeQL packs to apply this command to.

--format=<fmt>

Select output format, eithertext(default) orjson.

--groups=[-]<group>[,[-]<group>...]

List of CodeQL pack groups to include or exclude from this operation. Aqlpack in the given workspace is included if:

• It is in at least one of the groups listed without a minus sign (thiscondition is automatically satisfied if there are no groups listedwithout a minus sign), and
• It is not in any group listed with a minus sign

Options to set up compilation environment

--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;).

--library-path=<dir>[:<dir>...]

[Advanced] An optional list of directories that will be added to theraw import search path for QL libraries. This should only be used ifyou're using QL libraries that have not been packaged as QL packs.

(Note: On Windows the path separator is;).

--dbscheme=<file>

[Advanced] Explicitly define which dbscheme queries should be compiledagainst. This should only be given by callers that are extremely surewhat they're doing.

--compilation-cache=<dir>

[Advanced] Specify an additional directory to use as a compilationcache.

--no-default-compilation-cache

[Advanced] Don't use compilation caches in standard locations such asin the QL pack containing the query or in the CodeQL toolchaindirectory.

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.