The Twilio CLI Microvisor Support
Microvisor Public Beta
Microvisor is in a pre-release phase and the information contained in this document is subject to change. Some features referenced below may not be fully available until Microvisor’s General Availability (GA) release.
The Twilio CLI command-line tool lets you to manage your Twilio resources from a terminal or the command prompt. It supports all Microvisor REST API operations and, with the addition of its Microvisor plugin, a number of additional procedures such as bundle creation, application logging, and remote-debugging facilitation.
This guide focuses on the functions provided by the Twilio CLI itself. For functions that are enabled by the Microvisor plugin, please see this additional guide.
Installation
To install and set up the Twilio CLI on your development machine, please see the Twilio CLI Quickstart.
Twilio CLI Microvisor functionality
The Twilio CLI provides easy access to the following Microvisor REST API operations. Additional options are listed afterwards. Plugin-enabled functionality is listed separately.
Apps
- List all Apps
twilio api:microvisor:v1:apps:list
- Get a specific App
twilio api:microvisor:v1:apps:fetch --sid <APP_SID>
- Delete a specific App
twilio api:microvisor:v1:apps:remove --sid <APP_SID>
Devices
- List all Devices
twilio api:microvisor:v1:devices:list
- Get a specific Device
twilio api:microvisor:v1:devices:fetch --sid <DEVICE_SID>
- Update a specific Device
twilio api:microvisor:v1:devices:update --sid <APP_SID>
Command options
The following options are available to be added to some or all of the calls listed above. The list is not comprehensive: we have only included CLI options essential to or useful for Microvisor-specific operations.
-o {format}
- Applies to all above calls.
- Presents the output in the specified format, or suppress output.
{format}
is one ofjson
,columns
,tsv
ornone
. Default:columns
.
--properties {list}
- Applies to all
:list
,:fetch
calls. - Presents the specified API resource properties when the output format is
columns
ortsv
.{list}
is a comma-separated list of property names. Please see the API documentation for a list of each resource’s properties. Default:sid,uniqueName
.
- Applies to all
--unique-name {name}
- Applies to
devices:update
. - Sets the specified Device’s friendly name, which may be used in place of its SID.
- Applies to
--target-app {sid}
- Applies to
devices:update
. - Deploys the specified App to the specified Device.
- Applies to
--help
- Applies to all above calls.
- Shows additional help information.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.