{"meta":{"title":"resolve extractor","intro":"[Deep plumbing] Determine the extractor pack to use for a given\nlanguage.","product":"Security and code quality","breadcrumbs":[{"href":"/en/code-security","title":"Security and code quality"},{"href":"/en/code-security/reference","title":"Reference"},{"href":"/en/code-security/reference/code-scanning","title":"Code scanning"},{"href":"/en/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/en/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"CodeQL CLI manual"},{"href":"/en/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extractor","title":"resolve extractor"}],"documentType":"article"},"body":"# resolve extractor\n\n[Deep plumbing] Determine the extractor pack to use for a given\nlanguage.\n\n> [!NOTE]\n> 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.\n>\n> To see details of the options available for this command in an earlier release, run the command with the <span style=\"white-space: nowrap;\">`--help`</span> option in your terminal.\n\n## Synopsis\n\n```shell copy\ncodeql resolve extractor --language=<lang> <options>...\n```\n\n## Description\n\n\\[Deep plumbing] Determine the extractor pack to use for a given\nlanguage.\n\n## Options\n\n### Primary Options\n\n#### `-l, --language=<lang>`\n\n\\[Mandatory] The name of the extractor to locate.\n\n#### `--search-path=<dir>[:<dir>...]`\n\nA list of directories under which extractor packs may be found. The\ndirectories can either be the extractor packs themselves or directories\nthat contain extractors as immediate subdirectories.\n\nIf the path contains multiple directory trees, their order defines\nprecedence between them: if the target language is matched in more than\none of the directory trees, the one given first wins.\n\nThe extractors bundled with the CodeQL toolchain itself will always be\nfound, but if you need to use separately distributed extractors you need\nto give this option (or, better yet, set up `--search-path` in a\nper-user configuration file).\n\n(Note: On Windows the path separator is `;`).\n\n#### `--just-check`\n\nDon't print any output, but exit with code 0 if the extractor is found,\nand code 1 otherwise.\n\n#### `--format=<fmt>`\n\nSelect output format. Choices include:\n\n`text` _(default)_: Print the path to the found extractor pack to\nstandard output.\n\n`json`: Print the path to the found extractor pack as a JSON string.\n\n`betterjson`: Print details about the found extractor pack as a JSON\nstring.\n\n### Common options\n\n#### `-h, --help`\n\nShow this help text.\n\n#### `-J=<opt>`\n\n\\[Advanced] Give option to the JVM running the command.\n\n(Beware that options containing spaces will not be handled correctly.)\n\n#### `-v, --verbose`\n\nIncrementally increase the number of progress messages printed.\n\n#### `-q, --quiet`\n\nIncrementally decrease the number of progress messages printed.\n\n#### `--verbosity=<level>`\n\n\\[Advanced] Explicitly set the verbosity level to one of errors,\nwarnings, progress, progress+, progress++, progress+++. Overrides `-v`\nand `-q`.\n\n#### `--logdir=<dir>`\n\n\\[Advanced] Write detailed logs to one or more files in the given\ndirectory, with generated names that include timestamps and the name of\nthe running subcommand.\n\n(To write a log file with a name you have full control over, instead\ngive `--log-to-stderr` and redirect stderr as desired.)\n\n#### `--common-caches=<dir>`\n\n\\[Advanced] Controls the location of cached data on disk that will\npersist between several runs of the CLI, such as downloaded QL packs and\ncompiled query plans. If not set explicitly, this defaults to a\ndirectory named `.codeql` in the user's home directory; it will be\ncreated if it doesn't already exist.\n\nAvailable since `v2.15.2`."}