Skip to content

Latest commit

 

History

History
111 lines (77 loc) · 4.11 KB

README.md

File metadata and controls

111 lines (77 loc) · 4.11 KB
Raw

Greengrass Development Kit - Command Line Interface

CI codecov

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0

The AWS IoT Greengrass Development Kit Command-Line Interface (GDK CLI) provides features that help you develop custom Greengrass components. You can use the GDK CLI to create, build, and publish custom components. When you create a component repository with the GDK CLI, you can start from a template or a community component from the Greengrass Software Catalog.

Please follow the GDK CLI public documentation to learn more about the available commands and configuration that GDK CLI has to offer.



Getting Started

Prerequisites

  1. Python3 and pip: As the GDK CLI tool is written in python, you need to have python3 and pip installed. The most recent version of python includes pip.

  2. AWS CLI: As you'd have to configure your AWS credentials using AWS CLI before running certain gdk commands.

1. Installing CLI

To install the latest version of CLI using this git repository and pip, run the following command

pip3 install git+https://github.com/aws-greengrass/aws-greengrass-gdk-cli.git@v1.6.2

Run gdk --help to check if the cli tool is successfully installed.

2. Configure AWS credentials

Configure AWS CLI with your credentials as shown here - https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html.

3. Quick start wih HelloWorld component written in python

Note: Following steps are focused as a quick start guide. For more detailed steps, refer our documentation.

  1. Initializes new project with a HelloWorld Greengrassv2 component.

gdk component init --template HelloWorld --language python -n HelloWorld

  1. Change directory to HelloWorld.

cd HelloWorld

  1. Update configuration in gdk-config.json

    1. Config file gdk-config.json would have placeholders:
     {
     "component": {
         "com.example.PythonHelloWorld": {
             "author": "<PLACEHOLDER_AUTHOR>",
             "version": "NEXT_PATCH",
             "build": {
                 "build_system": "zip"
             },
             "publish": {
                 "bucket": "<PLACEHOLDER_BUCKET>",
                 "region": "<PLACEHOLDER_REGION>"
             }
         }
     },
     "gdk_version": "1.0.0"
 }
    1. Replace <PLACEHOLDER_AUTHOR> with your name, <PLACEHOLDER_BUCKET> with a prefix for an Amazon S3 bucket name and <PLACEHOLDER_REGION> with an AWS region. The specified bucket will be created in the specified region if it doesn't exist (name format: {PLACEHOLDER_BUCKET}-{PLACEHOLDER_REGION}-{account_number}).
    2. After replace these value the gdk-config.json file should look similar to:
     {
     "component": {
         "com.example.PythonHelloWorld": {
             "author": "J. Doe",
             "version": "NEXT_PATCH",
             "build": {
                 "build_system": "zip"
             },
             "publish": {
                 "bucket": "my-s3-bucket",
                 "region": "us-east-1"
             }
         }
     },
     "gdk_version": "1.0.0"
 }

  2. Build the artifacts and recipes of the component.

gdk component build

  1. Creates new version of the component in your AWS account.

gdk component publish



Running Tests


  • Unit tests: make tests_unit
  • Integration tests: make tests_integration