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 access-tokens
Generating test data and dashboard access tokens.
-o, --organisation-id <type>
Optional. ID of your organisation. Defaults to the signed in organisation -u, --user-reference <type>
Optional. An ID to identify the current user Default: Default user reference -t, --type <type>
Optional. Either 'admin' or 'standard' Default: standard -s, --scope <scope>
Optional. Either 'read' or 'read_write' Default: read_write -pk, --private-key <type>
Optional. Path to your private key. Default: vizzly-private.pem
vizzly list-data-sets
List data sets on a query engine.
-q, --queryEngineEndpoint <endpoint>
Required. Endpoint of the query engine, including a base path if you have one set. (This should start with http or https) -dc, --dynamic-config <type>
Optional. Path to your Vizzly config. -pk, --private-key <type>
Optional. Path to your private key. Default: vizzly-private.pem
vizzly config-manager
Open the vizzly config manager for self-hosted integrations.
-q, --queryEngineEndpoint <endpoint>
Required. Endpoint of the query engine, including a base path if you have one set. (This should start with http or https) -p, --project-id <type>
Optional. ID of the Vizzly project -t, --ttl-in-minutes <type>
Optional. Time to live (TTL) of the token used access the config builder Default: 600 -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 https://app.vizzly.co/cli-auth
vizzly format-public-pem-for-env
Convert your public Vizzly PEM file into a JSON string to be used in the Vizzly Query Engine with the VIZZLY_PUBLIC_KEYS env variable.
-pub, --public-key <type>
Optional. Path to your public key. Default: vizzly-public.pem
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 -p, --project-id <type>
Required. ID of the project to add the public key too
vizzly create-key-pair
Create public and private key pairs
-p, --prefix <type>
Optional. Prefix of the generated public and private keys.
vizzly init-config
Create skeleton of the Vizzly config file.
-i, --integration <integration>
Required. Integration type Choices: bigquery, mariadb, postgres, snowflake, mysql -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: bigquery, mariadb, postgres, snowflake, mysql -pub, --public-key <type>
Optional. Path to your public key. Default: vizzly-public.pem