@telegraph-notify/telegraph-cli v1.0.1

Telegraph CLI

Table of Contents

• Installation
• Getting Started
• Deploying to AWS
• Tearing Down
• Changing the secret key
• Changing the dashboard API key

Installation

Run the following command to install Telegraph CLI.

$ npm install -g @telegraph-notify/telegraph-cli

Getting Started

You must have aws-cli, aws-cdk, and git-cli installed to begin the initialization process. The installation status of these applications can be verified by running the following commands and getting back a file path.

$ which aws
$ which cdk
$ which git

An AWS account must have been created, along with an AWS IAM role with AdministratorAccess permissions. The access key and secret access key must have also been created on the Security Credentials page.

The AWS CLI must be configured by running the aws configure command. The account and region must be specified using the access keys created in the previous step.

Secret keys to be used in conjunction with the SDKs will be displayed after deployment in addition to URLs to the API gateways. Please save these as they are necessary to integrate Telegraph services.

To initialize Telegraph and ensure your environment is ready for deployment, run:

$ telegraph init

You will be prompted to enter an email address to be used as the sender's email for email notification, the application's secret key, and the API key for the dashboard. The secret key and API key can be left blank to automatically generate them.

Deploying to AWS

Telegraph is ready to be deployed to AWS after a successful initialization.

$ telegraph deploy

Note: The deployment of Telegraph can take about 10 minutes.

Tearing down Telegraph

To delete Telegraph from AWS, run:

$ telegraph destroy

Note: The removal of Telegraph can take about 10 minutes.

Changing the Secret Key

To change the secret key on AWS, run:

$ telegraph secretkey

Changing the Dashboard API Key

To change the dashboard API key on AWS, run:

$ telegraph apikey