@vonage/cli-core

Vonage Core CLI

This is the core package for all Vonage CLI commands. It contians the base VonageCommand, VonageConfig, common User Experience (UX), and Filesystem (fs) functionality. Since this pacakge contains the config functionality, it also adds configuration commands to the CLI.

VonageCommand

The VonageCommand base class, provides global CLI arguments which can be used to configure @vonage/auth and @vonage/server-sdk. Along with the configuration, standard UX functions for outputting data is also provided. Keeping a consistent UX is pivitol for the CLI so it is recommended that you use these functions.

Configuration

Config settings are parsed into the CLI in four ways (in order):

1. From command line arguments, (--api-key,--api-secret, --private-key, and --application-id)
2. Reading in from $CWD/vonage_app.json file
3. The VONAGE_API_KEY, VONAGE_API_SECRET, VONAGE_PRIVATE_KEY, and VONAGE_APPLICATION_ID environment variables
4. A Global config file loacated at $XDG_CONFIG_HOME/@vonage/cli/vonage.config.json

Configuration API

By having your command extend VonageCommand you will get access to the base configuration parameters. It is recommened that you do not interact While you shouldn't need to access variables directly, the best way is to use vonageConfig.getVar(<which>) from the VonageCommand base class. VonageConfig also exposes methods from saving the global or local config (again these are use at your own risk)

Commands Provided

1. vonage config (vonage config:setup, vonage setup): Initial configuration setup wizard
2. vonage config:show: A utility command that displays the configuration
3. vonage config:set SETTING VALUE A utility command to set an individual configuration setting