The squirro_widget
comand line tool, part of the Toolbox, is used to manage custom widgets on a Squirro cluster.
Table of Contents
Basic Usage
The squirro_widget command is used on the command line. It takes a number of connection options first (--cluster
and --token
), followed by a command (list
in the example below) and depending on the command additional options after it.
squirro_widget ^ --token SQUIRRO_TOKEN ^ --cluster https://next.squirro.net ^ list
Note that the lines have been wrapped with the circumflex (^) at the end of each line. On Mac and Linux you will need to use backslash (\) instead.
Arguments
The following table lists all the arguments.
Argument | Mandatory | Description |
---|---|---|
General Options | ||
-h | Show a help message and exit. | |
--version | Output the tool version and exit. | |
--verbose, -v | Increase log verbosity.
| |
--log-file | Path to a log file on disk, where the log output is to be stored. If this is not specified, the log messages are shown on the console. | |
Connection Options (see Connecting to Squirro for finding these values) | ||
--token TOKEN -t TOKEN | Yes | The Authentication Token with which to authenticate. If the token value starts with a dash, you need to use an equal sign to specify the value like this: --token="-12345…" |
--cluster URL | The Squirro cluster into which to import the data. |
Commands
The command is given as an argument after all the previous options. There are two supported commands:
list
– Lists all the custom widgets that have been configured on the server.upload
– Uploads a new or modified custom widget.
List
This command lists all the custom widgets that have been configured on the server.
The list
command does not take any additional options beyond the default arguments.
An example:
squirro_widget ^ --token SQUIRRO_TOKEN ^ --cluster https://next.squirro.net ^ list
Note that the lines have been wrapped with the circumflex (^) at the end of each line. On Mac and Linux you will need to use backslash (\) instead.
Upload
The upload command uploads a custom widget from the local disk and uploads it to the Squirro cluster. This command takes additional options beyond the default arguments.
Argument | Mandatory | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
--config | Yes | A JSON representation of the configuration for the widget. The following keys are possible:
|
An example:
squirro_widget ^ --cluster https://next.squirro.net ^ --token $TOKEN ^ upload ^ --config '{"directory": "clock", "title": "Clock", "baseWidget": "Base"}'