Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
titleWarning

This documentation will soon be updated Filippo Broggini

...

Code Block
languagepowershell
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.

ArgumentMandatoryDescription
General Options
-h
Show a help message and exit.
--version
Output the tool version and exit.
--verbose, -v

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.
--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
YesThe 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
-c URL


The Squirro Cluster into which to import the data.

...

Code Block
languagepowershell
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.

...