| 1 | # twilio-cli-core
|
| 2 |
|
| 3 | This module contains core functionality for the twilio-cli.
|
| 4 |
|
| 5 | ## Base commands
|
| 6 |
|
| 7 | ### BaseCommand
|
| 8 |
|
| 9 | The base command class for _all_ twilio-cli commands. Includes support for configuration management, logging, and output formatting.
|
| 10 |
|
| 11 | ### TwilioClientCommand
|
| 12 |
|
| 13 | A base command class for commands that need a Twilio client to make API requests. Handles loading credentials from the project configuration.
|
| 14 |
|
| 15 | ## Services
|
| 16 |
|
| 17 | ### Output formats
|
| 18 |
|
| 19 | Formatters to take a JSON array and write to the stdout. Current formatters include:
|
| 20 |
|
| 21 | - Columns (default, human readable)
|
| 22 | - JSON (raw API output)
|
| 23 | - TSV
|
| 24 |
|
| 25 | ### CliRequestClient
|
| 26 |
|
| 27 | A custom http client for the Twilio helper library to allow us to log API requests as well as modify the User-Agent header.
|
| 28 |
|
| 29 | ### Config
|
| 30 |
|
| 31 | Manages the CLI configuration options, such as Twilio projects and credentials.
|
| 32 |
|
| 33 | ### Logger
|
| 34 |
|
| 35 | Standardizes logging output of debug, info, warning, and error messages to stderr (all go to stderr to allow differentiation between command output and logging messages).
|
| 36 |
|
| 37 | ### SecureStorage
|
| 38 |
|
| 39 | An abstraction around the keytar npm package which further abstracts platform-level data encryption services for storing Twilio credentials securely.
|