greengrass-cli v1.0.10

green-cli

A deployment, management and monitoring command-line tool for AWS Greengrass.

Current version: 1.0.10

Lead Maintainer: Halim Qarroum

Table of contents

• Installation
• Features
• Description
• Usage
• Examples
• See also

Install

To install the green-cli command-line tool on your development machine, run the following command :

npm install --global greengrass-cli

This application has a dependency on both required and optional software packages, you will find a list of the expected environment for green-cli to be able to properly work.

Required dependencies

The only dependency green-cli has is to be able to retrieve STS tokens from AWS in order to interact with your AWS account. The easiest way to achieve this is to have the AWS CLI installed and configured on your deployment machine (read more on Installing the AWS CLI and Configuring the AWS CLI.

The permissions required for the green-cli to operate your AWS Greengrass fleet is documented in the Wiki in the Required Permissions section

Optional dependencies

green-cli makes use of the green-sys lambda application for Greengrass and the sys-get command-line tool to offer dashboarding and remote shell access to remote Greengrass hosts.

To install sys-get on your system, simply run :

npm install --global sys-get

For more information on how to deploy green-sys, please read the green-sys documentation.

Features

• Deployment and configuration of lambda functions on your Greengrass Core nodes.
• Supports NPM and the local filesystem as a source for lambda function packages.
• Supports deployment of dependencies between lambda function packages.
• Supports Deployment Templates describing the configuration of a group of Greengrass Cores (akin to Cloudformation, for the edge).
• Provides live logging of Lambda function outputs in your Terminal.
• Provides information as well as a dependency graph of your Lambda packages.
• Remote shell support on the Greengrass host using green-sys.
• Remote live dashboard of the Greengrass host system metrics using sys-get

Description

The green-cli application is a command-line tool aiming to be used mainly by Developers and DevOps teams which are looking for an efficient way to deploy Lambda packages on AWS Greengrass. This application can be seen as :

• A package and dependency manager for Greengrass.
• A deployment facility for Developers and DevOps.
• A monitoring tool that interacts directly with Greengrass Cores.

The command-line tool currently supports NPM and the local filesystem as sources for your lambda packages. Whether or not NPM is used, green-cli will look for a package.json description file at the root of every package to gather the necessary metadata to realize the deployment of a Greengrass application, read more in the How to write an application guide.

Usage

Creating a green-app manifest

Creating a green-deployment manifest

Linting manifest files

Creating a deployment

Deploying Lambda packages to the edge

Working with Deployment Templates

Retrieving logs from your running lambda functions

green-cli connects to AWS Cloudwatch to retrieve the live log feed of your running Lambda functions.

See also

\ - The Expressify framework.

• The sys-get command-line tool.
• The green-sys Lambda system monitoring application.