В этом материале описывается последний выпуск Интерфейса командной строки CodeQL. Дополнительные сведения об этом выпуске см. в разделе https://github.com/github/codeql-cli-binaries/releases.
Чтобы просмотреть сведения о параметрах, доступных для этой команды в более раннем выпуске, выполните команду с параметром в терминале --help .
Краткий обзор
codeql resolve files <options>... -- <dir>Описание
[Глубокая сантехника] Расширение набора включенных и исключаемых файлов.
Эта команда сантехники отвечает за расширение параметров командной строки подкоманд, которые работают с несколькими файлами, определяемыми по их путям. По умолчанию включены все файлы, поэтому при выполнении этой команды без аргументов фильтра будут собраны все файлы в каталоге.
Параметры --include, --excludeи --prune принимают стандартные шаблоны, которые могут использовать следующие подстановочные знаки:
- Один символ "?" соответствует любому символу, кроме косой черты вперед или назад;
- Один символ "*" соответствует любому количеству символов, кроме косой черты вперед или назад;
- Шаблон "**" соответствует нулю или более полным компонентам каталога.
Основные параметры
<dir>
Каталог, в котором необходимо выполнить поиск.
--format=<fmt>
Выберите формат вывода (textпо умолчанию) или json.
Параметры ограничения набора собранных файлов
--include-extension=<.ext>
Включите в дерево каталогов поиска все файлы с заданным расширением. Как правило, следует включить точку перед расширением.
Например, передача --include-extension .xml будет включать все файлы с расширением ".xml". Этот параметр несовместим с отрицающими --include параметрами.
--include=<glob>
Включите все файлы и каталоги в дерево каталогов поиска, которые соответствуют заданной схеме, используя относительный путь каждого файла и каталога из каталога поиска. Если объект начинается с символа ! , соответствующие файлы и каталоги будут исключены.
--include параметры обрабатываются по порядку, а более поздние параметры переопределяют предыдущие. Например, --include ** --include !sub/*.ts --include sub/main.* будет включать sub/main.ts (потому что он включен sub/main.*в ), exclude sub/index.ts (потому что он исключается !sub/*.tsв ) и include sub/test.js (потому что он включается без ** последующего исключения.)
--also-match=<glob>
Требовать, чтобы все результаты также соответствовали заданной схеме, используя относительный путь к каждому файлу и каталогу из каталога поиска. Этот параметр имеет ту же структуру и интерпретацию, что --include и , но задает отдельную последовательность стандартных объектов, которые применяются в сочетании с --include.
--exclude=<glob>
Исключите все файлы и каталоги, соответствующие заданной схеме, используя относительный путь к каждому файлу и каталогу из каталога поиска. Этот параметр переопределяет все параметры включения. Этот параметр несовместим с отрицающими --include параметрами.
--prune=<glob>
Исключите все файлы и каталоги, соответствующие заданной схеме, используя относительный путь к каждому файлу и каталогу из каталога поиска. Этот параметр переопределяет все параметры включения. Этот параметр несовместим с отрицающими --include параметрами.
--size-limit=<bytes>
Исключите все файлы, размер которых превышает заданное ограничение. Ограничение размера — в байтах или в кибибайтах (КиБ) с суффиксом «k», в мебибайтах (МиБ) с суффиксом «m» и в гибибайтах (ГиБ) с суффиксом «g». Этот параметр переопределяет все параметры включения.
--total-size-limit=<bytes>
Выполните выход команды с ошибкой, если общий размер всех разрешенных файлов превысит заданное ограничение. Ограничение размера — в байтах или в кибибайтах (КиБ) с суффиксом «k», в мебибайтах (МиБ) с суффиксом «m» и в гибибайтах (ГиБ) с суффиксом «g».
--[no-]follow-symlinks
Перейдите по любым символьным ссылкам на целевые объекты.
--[no-]find-any
Найти не более одного совпадения (в отличие от всех совпадений).
Доступно начиная с v2.11.3.
Общие параметры
-h, --help
Показать этот текст справки.
-J=<opt>
[Дополнительно] Предоставьте параметр виртуальной машине Java, запустив команду .
(Остерегайтесь, что параметры, содержащие пробелы, будут обрабатываться неправильно.)
-v, --verbose
Добавочное увеличение числа выводемых сообщений о ходе выполнения.
-q, --quiet
Постепенно уменьшайте количество выводемых сообщений о ходе выполнения.
--verbosity=<level>
[Дополнительно] Явно задайте уровень детализации для одной из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет -v и -q.
--logdir=<dir>
[Дополнительно] Запись подробных журналов в один или несколько файлов в заданном каталоге с созданными именами, включая метки времени и имя выполняющейся подкоманды.
(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого при необходимости предоставьте --log-to-stderr и перенаправьте stderr.)