1
0
mirror of synced 2025-12-21 02:46:50 -05:00
Files
docs/content/code-security/codeql-cli/codeql-cli-manual/resolve-metadata.md
2023-06-12 08:11:20 -07:00

83 lines
1.8 KiB
Markdown

---
title: resolve metadata
versions:
fpt: '*'
ghae: '*'
ghec: '*'
ghes: '*'
topics:
- Advanced Security
- Code scanning
- CodeQL
type: reference
product: '{% data reusables.gated-features.codeql %}'
autogenerated: codeql-cli
intro: |-
[Deep plumbing] Resolve and return the key-value metadata pairs from a
query source file.
redirect_from:
- /code-security/codeql-cli/manual/resolve-metadata
---
<!-- Content after this section is automatically generated -->
{% data reusables.codeql-cli.man-pages-version-note %}
## Synopsis
```shell copy
codeql resolve metadata <options>... -- <file>
```
## Description
\[Deep plumbing] Resolve and return the key-value metadata pairs from a
query source file.
## Primary options
#### `<file>`
\[Mandatory] Query source file from which to extract metadata.
#### `--format=<fmt>`
This option is ignored for future compatibility. Pass `json` here to be
sure to get the current JSON output format even in a future version.
### 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 `-v`
and `-q`.
#### `--logdir=<dir>`
\[Advanced] Write detailed logs to one or more files in the given
directory, with generated names that include timestamps and the name of
the running subcommand.
(To write a log file with a name you have full control over, instead
give `--log-to-stderr` and redirect stderr as desired.)