Skip to content

Commit

Permalink
Updating the CLI doc (#468)
Browse files Browse the repository at this point in the history
Co-authored-by: shrutiburman <[email protected]>
  • Loading branch information
sr010 and shrutiburman authored Sep 26, 2022
1 parent a650621 commit 2391af8
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Technology

Twilio CLI is built with the [oclif](https://oclif.io/) CLI framework for Node.js (v8 or higher) using the [“multi-command”](https://oclif.io/docs/multi) CLI template.
Twilio CLI is built with the [oclif (v2)](https://oclif.io/) CLI framework for Node.js (v14 or higher) using the [“multi-command”](https://oclif.io/docs/multi) CLI template.

The oclif framework [documentation](https://oclif.io/docs/introduction) has a general overview of the framework architecture, so this document will focus on the architecture-specific to the Twilio CLI.

Expand Down Expand Up @@ -125,7 +125,7 @@ To get access to your Twilio resources, the CLI needs an API key to access it. I

## Commands and topics

The Twilio CLI is a [“multi-command”](https://oclif.io/docs/multi) CLI in the same way that “git” is a multi-command CLI. This means you run “twilio <command>” to perform an operation, where <command> can be a single command like “help” or a topic + command combination like “incoming-phone-number:list”. Note the topic and command are separated by a colon (this may also support being separated by a space in [future oclif](https://github.com/oclif/oclif/issues/186) versions).
The Twilio CLI is a [“multi-command”](https://oclif.io/docs/multi) CLI in the same way that “git” is a multi-command CLI. This means you run “twilio <command>” to perform an operation, where <command> can be a single command like “help” or a topic + command combination like “incoming-phone-number:list”. Note the topic and command can be separated by a colon or a [space](https://github.com/oclif/oclif/issues/186).

Nesting commands under a topic are used to organize commands. The general relationship to the Twilio API Definitions is that a topic will correspond to a resource and the command corresponds to the action.

Expand All @@ -144,7 +144,7 @@ Commands can have aliases. For example, “login” is an alias for “profile:a

## Documentation and help

The CLI is self-documenting. All topics, commands, and their possible parameters with a short description of each can be discovered from the CLI itself using the “--help” flag. Topics and commands that correspond directly to resources and actions in API definitions will use the existing documentation present in the definitions. URLs to Twilio docs are present wherever official documentation is available.
The CLI is self-documenting. All topics, commands, and their possible parameters with a short description of each can be discovered from the CLI itself using the “--help” or "-h" flag. Topics and commands that correspond directly to resources and actions in API definitions will use the existing documentation present in the definitions. URLs to Twilio docs are present wherever official documentation is available.

![](/assets/images/help.png)

Expand Down
Binary file modified assets/images/CLI_overview.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2391af8

Please sign in to comment.