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.

	 -p, --project-id <type>
	 Required. ID of your project

	 -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

	 -sf, --secure-filters <path>
	 Optional. Path to JSON file containing secure filters.

	 -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

	 -qe, --with-query-engine-access
	 Optional. Also create a query engine access token, used to access your Query Engine.

	 -md, --managed-dashboard <string>
	 Optional. Provide the URL of your query engine, where the managed dashboard should be loaded.

vizzly config-manager

Open the vizzly config manager for self-hosted integrations.

	 -p, --project-id <type>
	 Required. ID of your project

	 -q, --queryEngineEndpoint <endpoint>
	 Optional. Endpoint of the query engine, including a base path if you have one set. (This should start with http or https)

	 -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 encryption-secret

Create an encryption secret for usage with the Vizzly Query Engine.

vizzly create-dashboard

Create a new dashboard using the CLI.

	 -p, --project-id <type>
	 Required. Project ID

	 -d, --definition <type>
	 Optional. Path to the JSON file containing the dashboard definition

	 -pd, --parent-dashboard-id <type>
	 Optional. Parent dashboard ID. If omitted, a parent dashboard will be created.

	 -pk, --private-key <type>
	 Optional. Path to your private key.
	 Default: vizzly-private.pem

vizzly encrypt

Encrypt the contents of a file.

	 -p, --project-id <type>
	 Required. Project ID

	 -s, --secret <type>
	 Optional. Root encryption secret (value of VIZZLY_ENCRYPTION_SECRET env var)

	 -j, --json-file <type>
	 Optional. Path to the JSON file of content to stringify and encrypt

vizzly decrypt

Decrypt the contents of a file.

	 -p, --project-id <type>
	 Required. Project ID

	 -s, --secret <type>
	 Optional. Root encryption secret (value of VIZZLY_ENCRYPTION_SECRET env var)

	 -e, --encrypted <type>
	 Optional. Path to a file containing the encrypted string

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 format-private-pem-for-env

Convert your private Vizzly PEM file into a base64 encoded string to make it easier to load onto your servers as an environment variable.

	 -pub, --private-key <type>
	 Optional. Path to your private key.
	 Default: vizzly-private.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 validate

Validates a Vizzly config

	 -c, --config <type>
	 Optional. Path to your Vizzly config.

vizzly create-key-pair

Create public and private key pairs

	 -p, --project-id <type>
	 Required. ID of the project to upload the public key too

	 -p, --prefix <type>
	 Optional. Prefix of the generated public and private keys.

vizzly upcast-config

Upcast a Vizzly Config.

	 -q, --query-engine-endpoint <endpoint>
	 Optional. Endpoint of the query engine, including a base path if you have one set. (This should start with http or https)

	 -c, --config-file <type>
	 Required. Path to your current vizzly config file.

vizzly setup

Create a Vizzly project.

vizzly managed

Setup resources for your managed query engine project.

	 -p, --project-id <type>
	 Required. ID of the managed project to set up

vizzly self-hosted

Create resources for a new Vizzly self-hosted project using the Query Engine.

	 -p, --project-id <type>
	 Required. ID of the project to set up

vizzly create-self-hosted-demo

Run a self-hosted version of Vizzly locally.

vizzly dynamic-self-hosted

Create resources for a new Vizzly self-hosted project using the Query Engine, where data connections and data sets can be dynamic.

	 -p, --project-id <type>
	 Required. ID of the project to set up

vizzly in-browser-self-hosted

Create resources for a new Vizzly self-hosted project using the in-browser Query Engine.

	 -p, --project-id <type>
	 Required. ID of the project to set up

vizzly encrypted-storage-config

Create the configuration needed to run the Vizzly Query Engine for persisting encrypted dashboards.

	 -p, --project-id <type>
	 Required. ID of the project to set up

vizzly query-engine-api-key

Generate a new API key and verification hash for the Vizzly Query Engine.

vizzly current-profile

Displays your current signed-in profile.

vizzly docs

Open the Vizzly docs.

vizzly init-frontend

Create a templated frontend Vizzly app.

	 -t, --type <type>
	 Required. Type
	 Choices: react

	 -n, --name <name>
	 Optional. Name of the frontend project
	 Default: vizzly-frontend

vizzly generate-pdf

Test PDF reports generated by a Vizzly Query Engine.

	 -p, --project-id <type>
	 Required. ID of your project

	 -d, --dashboard-version <version>
	 Required. 

	 -q, --query-engine-endpoint <endpoint>
	 Optional. Endpoint of the query engine, including a base path if you have one set. (This should start with http or https)

	 -u, --user-reference <type>
	 Optional. An ID to identify the current user
	 Default: Default user reference

	 -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