oc

This is a command-line utility for controlling an OpenChirp instance.

Usage

[Usage:
  oc [command]

Available Commands:
  device      Manage a device
  help        Help about any command
  monitor     Monitor any mqtt topic
  service     Manage a service
  user        Manage the user account

Flags:
  -i, --auth-id string            The authentication ID to use with the framework server
  -t, --auth-token string         The authentication token to use with the framework server
  -s, --framework-server string   Specifies the framework server (default "http://localhost")
  -h, --help                      help for oc
  -m, --mqtt-server string        Specifies the mqtt server (default "tcp://localhost:1883")
      --version                   version for oc

Use "oc [command] --help" for more information about a command.](Usage:
  oc [command]

Available Commands:
  check       Returns the self-reported health of the framework server
  config      Print out current config settings in use
  device      Manage a device
  group       Manage groups
  help        Help about any command
  monitor     Monitor any mqtt topic
  service     Manage a service
  user        Manage the user account

Flags:
  -i, --auth-id string            The authentication ID to use with the framework server
  -t, --auth-token string         The authentication token to use with the framework server
  -s, --framework-server string   Specifies the framework server (default "http://localhost")
  -h, --help                      help for oc
  -m, --mqtt-server string        Specifies the mqtt server (default "tcp://localhost:1883")
  -v, --verbose                   Enable verbose logging

Use "oc [command] --help" for more information about a command.)

Example Usage

Services

Create Service

$ oc -s https://api.openchirp.io -i myid -t mycomplextoken service create service1name "This is a simple example service"
5c4f886a3859df43aad0f1ef

Generate Service Token

$ oc -s https://api.openchirp.io -i myid -t mycomplextoken service token generate 5c4f886a3859df43aad0f1ef

Monitor a Service

$ oc -s https://api.openchirp.io -i myid -t mycomplextoken service monitor 5c4f886a3859df43aad0f1ef

Config Files

You can save a local config file in any of the following locations:

• /etc/occonfig.toml
• ~/.config/oc/occonfig.toml
• ~/.oc/occonfig.toml
• ./occonfig.toml

The content of the config file should look similar to the below:

framework-server = "https://api.openchirp.io"
mqtt-server = "tls://mqtt.openchirp.io:8883"
auth-id = "your-user-id"
auth-token = "your-user-token"