Command Line Interface

The bluecherry-client can be used as a scriptable command line tool to access the various BlueCherry device services. The following commands are currently available:

Help

This command really speaks for itself, it prints out a help page to standard output.

Hello

This command will simply send a request to the BlueCherry service in order to check if a connection can be established.

Provision

This is the command that you should use the first time your about to connect a new device to the platform. It will request you to enter your username and password, this way we can validate if you are allowed to provision a device aswell as check if you've got credits to provision a device.

Show-config

This simply prints out the config that was generated by the provision to your stdout.

Set-default-port

This will set a default port in the generated config. Meaning that the app will always use this port to forward local apps.

Set-notification-destinations

This will set the offline_destination list in your local configuration and synchronize the list with the BlueCherry cloud. If your device goes offline or comes online all destinations in this list will be notified.

Start

Start the BlueCherry connection and connect to the BlueCherry platform.

Sync-notification-destinations

This will sync the local offline_destination list to the BlueCherry cloud. If something went wrong with the set-notification-destinations command and you could not sync your local destinations you may use this command to retry a synchronization.

Mail

With this command you have to possibility to send out mails from the terminal. The only required parameters are --destinations, --subject and --body. In order to get more information you can execute this command with the --help flag aswell.

Sms

With this command you have to possibility to send out text messages from the terminal. The only required parmaters are --destinations and --content. In order to get more information you can execute this command with the --help flag aswell.

Call

With this command you have to possibility to make virtual phonecalls from the terminal. The only required parameters are --destinations and --content. In order to get more information you can execute this command with the --help flag aswell.

Push-notification

With this command you have to possibility to send out push-notifications from the terminal. The only required things are a --destinations and --content flag. In order to get more information you can execute this command with the --help flag aswell.

Config example

# Authentication config values
auth:
  type_id: <string>
  dev_id: <string>
  dev_key: <string>
  ssh_key_path: <path to ssh_key>

# Connection config values
connection:
  port: <int>

# A list of offline notification destinations
offline_destination_list:
  - id: <int>
    type: <int>
    destination: <string>
    language: <string>
    name: <string>