Synopsis

codeql resolve files <options>... -- <dir>

codeql resolve files <options>... -- <dir>

Description

[Deep plumbing] Expand a set of file inclusion/exclusion globs.

This plumbing command is responsible for expanding the command-lineparameters of subcommands that operate on multiple files, identified bytheir paths. By default, all files are included, and so running thiscommand without any filter arguments will collect all files in adirectory.

The--include,--exclude, and--prune options all take globpatterns, which can use the following wildcard characters:

• A single "?" matches any character other than a forward/backwardslash;
• A single "*" matches any number of characters other than aforward/backward slash;
• The pattern "**" matches zero or more complete directorycomponents.

Options

Primary Options

<dir>

The directory to be searched.

--format=<fmt>

Select output format, eithertext(default) orjson.

Options for limiting the set of collected files

--include-extension=<.ext>

Include all files in the search directory tree that have the givenextension. Typically, you should include the dot before the extension.For example, passing--include-extension .xml will include all fileswith the ".xml" extension. This option is incompatible with negated--include options.

--include=<glob>

Include all files and directories in the search directory tree thatmatch the given glob, using each file and directory's relative pathfrom the search directory. If the glob begins with a! character, thematching files and directories would instead be excluded.

--include options are processed in order, with later optionsoverriding earlier ones. For example,--include ** --include !sub/*.ts --include sub/main.* would includesub/main.ts (because it is included bysub/main.*), excludesub/index.ts (because it is excluded by!sub/*.ts), and includesub/test.js (because it is included by** without being subsequentlyexcluded.)

--also-match=<glob>

Require all results to also match the given glob, using each file anddirectory's relative path from the search directory. This option hasthe same structure and the same interpretation as--include butspecifies a separate sequence of globs that are applied in conjunctionwith--include.

--exclude=<glob>

Exclude all files and directories that match the given glob, using eachfile and directory's relative path from the search directory. Thisoption overrides all include options. This option is incompatible withnegated--include options.

--prune=<glob>

Exclude all files and directories that match the given glob, using eachfile and directory's relative path from the search directory. Thisoption overrides all include options. This option is incompatible withnegated--include options.

--size-limit=<bytes>

Exclude all files whose size exceeds the given limit. The size limit isin bytes, or in kibibytes (KiB) with the "k" suffix, in mebibytes(MiB) with the "m" suffix, and in gibibytes (GiB) with the "g"suffix. This option overrides all include options.

--total-size-limit=<bytes>

Make the command exit with an error if the combined size of all resolvedfiles would exceed the given limit. The size limit is in bytes, or inkibibytes (KiB) with the "k" suffix, in mebibytes (MiB) with the "m"suffix, and in gibibytes (GiB) with the "g" suffix.

--[no-]follow-symlinks

Follow any symbolic links to their targets.

--[no-]find-any

Find at most one match (as opposed to all matches).

Available sincev2.11.3.

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.