CodeQL documentation

generate log-summary


codeql generate log-summary <options>... [--] <input> <result>


[Advanced] Create a summary of a structured log file.

This command creates a summary of a structured JSON evaluator event log. The output of this command aims to be more stable across different versions of the CLI than the log files themselves. Thus, when implementing a script that uses output from the logs, it is strongly recommended to run this command and use its output rather than using the event logs directly.



Path to the event log file to produce a summary of.


Path to the location to output the summarised log file to.


Omit whitespace in the outputted summary. The result will be less human-readable but take up less memory.


[Advanced] Control the format of the output produced. Currently two options are possible:

  • predicates: Produce a summary of the computation performed for each predicate. This is the default format if this option is not passed.
  • stats: Produce some brief summary statistics about the evaluation run.

Common options

-h, --help

Show this help text.


[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.


[Advanced] Explicitly set the verbosity level to one of errors, warnings, progress, progress+, progress++, progress+++. Overrides -v and -q.


[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.)

  • © GitHub, Inc.
  • Terms
  • Privacy