| Info | ||
|---|---|---|
| ||
This documentation will soon be updated Filippo Broggini |
| Excerpt |
|---|
The |
Table of Contents
| 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.
| Code Block | ||
|---|---|---|
| ||
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.
...
Increase log verbosity.
- Not specified: the tool outputs all warnings and errors.
- Specified once or more: informational messages are also output.
- Specified twice or more: debugging messages are shown.
- Specified three times or more: more information is included in all messages.
...
--cluster URL
-c URL
...
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:
| Code Block | ||
|---|---|---|
| ||
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.
...
A JSON representation of the configuration for the widget. The following keys are possible:
| Key | Description |
|---|---|
| directory | The local directory in which the widget is stored - relative to the current working directory. The directory is also used to determine the widget name. That name is used for deduplication, any older widgets with the same name are overwritten. |
| title | The name of the widget. This is the name shown to users when they add the widget to a dashboard. |
| baseWidget | The name of the base widget from which this one inherits. This drives the configuration options that are displayed to the user when adding the widget to a dashboard. See the list of Base Widgets for possible values here |
| author | The author of the widget |
| description | A short description of why the widget is needed or what it does |
An example:
...
| language | powershell |
|---|
...
This page can now be found at Squirro Asset CLI Reference on the Squirro Docs site.