This page summarizes the CLI commands and the options for each command. To learn
more about each Checks CLI command, use the --help option, for
example, checks login --help or checks reports --help.
Usage
checks GROUP | COMMAND ARGUMENT \
[OPTIONAL=FLAG_ARGUMENT] \
{OPTIONAL_A | OPTIONAL_B}
[CHECKS_WIDE_FLAG …]
Available CLI commands
Configuration
Command |
Description |
login |
Authenticates the CLI to your Google Account. Requires web browser access. |
update |
Gets the most recent version of the Checks CLI that's available. |
help |
Displays help information about the CLI or specific commands. |
version |
Prints version information for Checks CLI components and includes a message if updates are available. |
Reports
Command |
Description |
report generate |
Generate a report asynchronously under the specified account and app using a provided binary. |
report get |
Fetch data from the specified app's report. |
report operations wait |
Poll a long-running report operation until it completes. When the operation is complete, this command will display the results of the report. |
report operations list |
List all report operations under the specified account. |
Common flags
Flag |
Description |
account-id |
Used to refer to a specific Checks account. |
help |
Provides the help documentation for a given command, including the supported flags and arguments. |
version |
Print version information of the CLI and exit. This flag is only available globally. |
no-input |
This allows users an explicit way to disable all prompts in commands. If the command requires input, fail and tell the user how to pass the information as a flag. |
json |
By default, responses are pretty-printed on the standard output. The
|
wait-and-print-report |
A convenience flag for the |