The Twilio CLI Microvisor Plugin

apps

The apps command provides the following sub-commands:

• bundle — Build an application bundle that can be uploaded. It has two required arguments:

  twilio microvisor:apps:bundle /path/to/bin path/to/bundle/zip

  The latter is the path at which the bundle will be created: the path you will subsequently pass into the create call as shown below.
  
  If you are using remote debugging, include the debugging public key with the --debug-auth-pubkey switch as follows:

  twilio microvisor:apps:bundle /path/to/bin /path/to/bundle/zip \
    --debug-auth-pubkey=/path/to/public/key/pem

  You can generate a suitable private-public key pair with the debug:generate_keypair sub-command.

• create — Upload an application bundle. It takes as its argument a path to the application bundle to upload:
  

  twilio microvisor:apps:create /path/to/bundle/zip

  
  If you specify a path that doesn’t reach a bundle file, or the uploaded file is not a bundle, an error will be thrown.
  
  Optionally, you may also provide a unique friendly name to help you locate and reference the bundle in future.:
  

  twilio microvisor:apps:create /path/to/app/bundle <OPTIONAL_UNIQUE_NAME>

debug

The debug command takes a device SID and a path to a remote debugging private key as its arguments. For more information on why this key is required and how it is generated, please see Microvisor Remote Debugging.

twilio microvisor:debug $MV_DEVICE_SID /path/to/private/key/pem

Your call may also include the --listen-port flag, which is used to select the port through which debugging data will flow.

twilio microvisor:debug $MV_DEVICE_SID /path/to/private/key/pem \
  --listen-port=<PORT_NUMBER>

The default port is 8001. If you specify an alternative port number, you will need to update your .gdbinit file or run the command

target remote localhost:<PORT_NUMBER>

within gdb.

It also has the following sub-commands:

• generate_keypair — Generate private and public remote debugging encryption keys. It takes two arguments: paths to where the generated private and public keys shold be stored:

  twilio microvisor:debug:generate_keypair \
    --debug-auth-privkey=/path/to/private/key/pem \
    --debug-auth-pubkey=/path/to/public/key/pem​

  If you don’t provide either or both key paths, your current working directory will be used.

logs

The logs command provides the following sub-commands:

• stream — Initiate log streaming. It takes as its argument a device SID — the Microvisor-enabled device from which you wish to receive log messages:
  

  twilio microvisor:logs:stream $MV_DEVICE_SID

  If you specify a device that isn’t associated with your account, an Unknown device SID error will be thrown.
  
  Your call may also include the -o flag, which is used to output log messages either in plain text (the default) or in JSON format:

  twilio microvisor:logs:stream $MV_DEVICE_SID -o=json​

  If you select JSON output, you can pipe the output of the command through the JQ utility to present the JSON in a more reader-friendly form:

  twilio microvisor:logs:stream $MV_DEVICE_SID -o=json​ | jq

  The contents of the JSON payload are described below. The plain text output is the value of a message object’s message property.