Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account

Greengrass CLI commands

PDF
RSS
Focus mode
Greengrass CLI commands - AWS IoT Greengrass

The Greengrass CLI provides a command line interface to interact locally with your AWS IoT Greengrass core device. Greengrass CLI commands use the following format.

$ greengrass-cli <command> <subcommand> [arguments]

By default, the greengrass-cli executable file in the /greengrass/v2/bin/ folder interacts with the version of the AWS IoT Greengrass Core software running in the /greengrass/v2 folder. If you call an executable that is not placed in this location, or if you want to interact with AWS IoT Greengrass Core software in a different location, then you must use one of the following methods to explicitly specify the root path of the AWS IoT Greengrass Core software that you want to interact with:

  • Set the GGC_ROOT_PATH environment variable to /greengrass/v2.

  • Add the --ggcRootPath /greengrass/v2 argument to your command as shown in the following example.

    greengrass-cli --ggcRootPath /greengrass/v2 <command> <subcommand> [arguments]

You can use the following arguments with any command:

  • Use --help for information about a specific Greengrass CLI command.

  • Use --version for information about the Greengrass CLI version.

This section describes the Greengrass CLI commands and provides examples for these commands. The synopsis for each command shows its arguments and their usage. Optional arguments are shown in square brackets.

Available commands
PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.