Checks CLI commands and options
Stay organized with collections
Save and categorize content based on your preferences.
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. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-20 UTC."],[[["\u003cp\u003eThis CLI tool enables you to manage and interact with Checks, including authentication, updates, report generation, and code scanning.\u003c/p\u003e\n"],["\u003cp\u003eUse the \u003ccode\u003e--help\u003c/code\u003e option with any command for detailed usage instructions (e.g., \u003ccode\u003echecks login --help\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eThe CLI is organized into command groups: Configuration, Reports, and Code, each offering specific functionalities.\u003c/p\u003e\n"],["\u003cp\u003eCommon flags like \u003ccode\u003eaccount-id\u003c/code\u003e, \u003ccode\u003ejson\u003c/code\u003e, and \u003ccode\u003ewait-and-print-report\u003c/code\u003e provide flexibility and control over CLI behavior.\u003c/p\u003e\n"],["\u003cp\u003eYou can find comprehensive information on all available commands and their options within this documentation.\u003c/p\u003e\n"]]],[],null,["# Checks CLI commands and options\n\nThis page summarizes the CLI commands and the options for each command. To learn\nmore about each Checks CLI command, use the `--help` option, for example,\n`checks login --help` or `checks reports --help`.\n\nUsage\n-----\n\n checks GROUP | COMMAND ARGUMENT \\\n [OPTIONAL=FLAG_ARGUMENT] \\\n {OPTIONAL_A | OPTIONAL_B}\n [CHECKS_WIDE_FLAG ...]\n\nAvailable CLI commands\n----------------------\n\n### Configuration\n\n|-------------|-------------------------------------------------------------------------------------------------------|\n| **Command** | **Description** |\n| **login** | Authenticates the CLI to your Google Account. Requires web browser access. |\n| **update** | Gets the most recent version of the Checks CLI that's available. |\n| **help** | Displays help information about the CLI or specific commands. |\n| **version** | Prints version information for Checks CLI components and includes a message if updates are available. |\n\n### Reports\n\n|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| **Command** | **Description** |\n| **report generate** | Generate a report asynchronously under the specified account and app using a provided binary. |\n| **report get** | Fetch data from the specified app's report. |\n| **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. |\n| **report operations list** | List all report operations under the specified account. |\n\n### Code\n\n|---------------|---------------------------------------------------------------------------|\n| **Command** | **Description** |\n| **code scan** | Scan your source code using Checks Code Compliance at the specified path. |\n\n### Common flags\n\n|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Flag** | **Description** |\n| **account-id** | Used to refer to a specific Checks account. |\n| **help** | Provides the help documentation for a given command, including the supported flags and arguments. |\n| **version** | Print version information of the CLI and exit. This flag is only available globally. |\n| **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. |\n| **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. |\n| **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. |"]]
