Checks CLI commands and options

AI-generated Key Takeaways

• This CLI tool enables you to manage and interact with Checks, including authentication, updates, report generation, and code scanning.

• Use the --help option with any command for detailed usage instructions (e.g., checks login --help).

• The CLI is organized into command groups: Configuration, Reports, and Code, each offering specific functionalities.

• Common flags like account-id, json, and wait-and-print-report provide flexibility and control over CLI behavior.

• You can find comprehensive information on all available commands and their options within this documentation.

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.

Code

Command	Description
code scan	Scan your source code using Checks Code Compliance at the specified path.

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 json flag can be used to format and change the default output to JSON format.
wait-and-print-report	A convenience flag for the report generate command that blocks the return of the command until the report is finished generating.