Vizzly CLI
The Vizzly CLI speeds up integrating with Vizzly. Here's how to install it, and the commands that are available for use;
Install
npm i @vizzly/cli -g
Then show all available commands in your terminal by running
vizzly --help
Commands
vizzly generate-identity-signature
Deprecated. Please use `access-tokens` instead.
-o, --organisation-id <type>
Required. ID of your organisation -d, --dashboard-id <type>
Required. Live dashboard ID -u, --user-reference <type>
Required. An ID to identify the current user -t, --type <type>
Required. Either 'editor' or 'standard' -pk, --private-key <type>
Optional. Path to your private key. Default: vizzly-private.pem
vizzly access-tokens
Generate a test identity signature.
-o, --organisation-id <type>
Required. ID of your organisation -d, --dashboard-id <type>
Required. Live dashboard ID -u, --user-reference <type>
Required. An ID to identify the current user -t, --type <type>
Required. Either 'editor' or 'standard' -pk, --private-key <type>
Optional. Path to your private key. Default: vizzly-private.pem
vizzly sign-in
Sign into Vizzly.
-t, --token <type>
Required. Single-use auth token found at app.vizzly.co
vizzly upload-public-key
Upload your public key to your Vizzly account.
-pub, --public-key <type>
Optional. Path to your public key. Default: vizzly-public.pem
vizzly create-key-pair
Create public and private key pairs
-p, --prefix <type>
Optional. Prefix of the generated public and private keys.
vizzly data-set-from-sql
Pass in a SQL statement to generate a data set for your config
-i, --integration <integration>
Required. Integration type Choices: mariadb, postgres, bigquery, elasticsearch -s, --sql <type>
Required. SQL to be used to build the fields.
vizzly init-config
Create skeleton of the Vizzly config file.
-i, --integration <integration>
Required. Integration type Choices: mariadb, postgres, bigquery, elasticsearch -pub, --public-key <type>
Optional. Path to your public key. Default: vizzly-public.pem
vizzly setup
Create a Vizzly project.
-i, --integration <integration>
Required. Integration type Choices: mariadb, postgres, bigquery, elasticsearch -pub, --public-key <type>
Optional. Path to your public key. Default: vizzly-public.pem
vizzly init-frontend
Create a templated frontend Vizzly app.
-n, --name <name>
Optional. Name of the frontend project Default: vizzly-frontend -t, --type <type>
Required. Type Choices: react
Last updated on December 22, 2022