{"meta":{"title":"pack ls","intro":"[Deep plumbing] List the CodeQL packages rooted at\nthis directory. This directory must contain a qlpack.yml or\n.codeqlmanifest.json file.","product":"Security and code quality","breadcrumbs":[{"href":"/en/enterprise-server@3.19/code-security","title":"Security and code quality"},{"href":"/en/enterprise-server@3.19/code-security/reference","title":"Reference"},{"href":"/en/enterprise-server@3.19/code-security/reference/code-scanning","title":"Code scanning"},{"href":"/en/enterprise-server@3.19/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/en/enterprise-server@3.19/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"CodeQL CLI manual"},{"href":"/en/enterprise-server@3.19/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ls","title":"pack ls"}],"documentType":"article"},"body":"# pack ls\n\n\\[Deep plumbing] List the CodeQL packages rooted at\nthis directory. This directory must contain a qlpack.yml or\n.codeqlmanifest.json file.\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 pack ls <options>... -- <dir>\n```\n\n## Description\n\n\\[Deep plumbing] List the CodeQL packages rooted at this directory.\nThis directory must contain a qlpack.yml or .codeqlmanifest.json file.\n\nAvailable since `v2.7.1`.\n\n## Options\n\n### Primary Options\n\n#### `<dir>`\n\nThe root directory of the package or workspace, defaults to the current\nworking directory. If this parameter points to a directory containing a\nqlpack.yml, then this operation will run on only that CodeQL package. If\nthis parameter points to a directory containing a codeql-workspace.yml,\nthen this operation will run on all CodeQL packages in the workspace.\n\n### Options for configuring which CodeQL packs to apply this command to.\n\n#### `--format=<fmt>`\n\nSelect output format, either `text` *(default)* or `json`.\n\n#### `--groups=[-]<group>[,[-]<group>...]`\n\nList of CodeQL pack groups to include or exclude from this operation. A\nqlpack in the given workspace is included if:\n\n* It is in at least one of the groups listed without a minus sign (this\n  condition is automatically satisfied if there are no groups listed\n  without a minus sign), and\n* It is not in any group listed with a minus sign\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`."}