GitHubGitHub (opens in a new tab)
  • Docs
  • Get started
      • Self hosted
      • In browser
    • Identity
      • Quick start
      • Production ready
      • React
      • Create React App
      • Vue
        • Introduction
        • Postgres setup
        • NodeJS Identity
        • React frontend
        • Introduction
        • Deploy the Query Engine
        • Dynamic Data Set
  • Dashboard
      • Core
      • identity
      • queryEngineEndpoint
      • dataSets
      • data
      • runQueries
      • queryEngineConfig
      • Multiple dashboards
      • dashboardId
      • parentDashboardId
      • Customization
      • theme
        • Accordion
        • Buttons
        • Charts
        • Dashboard
        • Dropdowns
        • Forms
        • Library
        • Modals
        • Notifications
        • Lists
        • Panels
        • Tables
        • Tabs
        • Live Examples
      • featureToggles
      • textOverrides
      • Icons
      • Component overrides
      • dataPanel
      • formatPanel
      • excludeComponents
      • includeComponents
      • developerTools
      • maxCSVDownloadLimit
      • numberFormatOptions
      • organizationName
      • Event handlers
      • onEditorUpdate
      • onViewClick
      • onDashboardFilterChange
      • Filters
      • dateFilterOptions
      • dashboardFilters
      • cascadeFilterSelection
      • Scheduled Reporting
      • reportScheduleOptions
    • Theme and experience
    • Management
    • Distribution
    • Log level
    • CSS
    • Libraries
    • Vue
    • HTML
    • Svelte
    • Angular
    • Self-hosted
      • Integrations
        • Snowflake
        • MariaDB
        • MySQL
        • Postgres
        • BigQuery
        • Local
        • Amazon Web Services
        • Google Cloud Platform
        • Heroku
      • Config
        • Config manager
        • Storage
          • Vizzly API
          • GitHub
          • AWS S3
          • BigQuery
          • MariaDb
          • MySQL
          • Postgres
          • Snowflake
      • Environment variables
      • Log level
      • Performance
      • SSL termination
      • GitHub Actions CI
        • Headers
        • Create Results
    • Custom
      • Query
      • Result
    • In-browser
    • Compare
  • Identity and Multi-Tenancy
    • Node client
    • Python client
    • Self sign
    • Load your private key from an environment variable
  • Webhooks
    • Get started
    • Scheduled reports
    • Parent & child dashboards
    • Identity Config
      • Access type
      • User reference
      • Database schema access
      • Secure filters
      • Scope
      • Data sets
      • Parent dashboard IDs
      • Project Id
      • Project Resources
    • Data set
    • Time format
    • Data type
    • Field
    • Verified views
    • View attributes
    • Query
    • Result
  • Architecture
  • Vizzly CLI
  • Key Pair
  • Parameters
  • Developer Support
        • 0.4.19
        • 0.4.18
        • 0.4.16
        • 0.4.13
        • 0.4.11
        • 0.4.9
        • 0.4.8
        • 0.4.7
        • 0.4.5
        • 0.4.4
        • 0.4.3
        • 0.4.0
        • 0.3.33
        • 0.3.31
        • 0.3.30
        • 0.3.29
        • 0.3.27
        • 0.3.25
        • 0.3.22
        • 0.3.21
        • v0.6.5
        • v0.6.4
        • v0.6.2
        • v0.6.1
        • v0.6.0
        • v0.5.3
        • v0.5.2
        • V0.6.6
        • V0.6.7
        • V0.6.8
        • V0.6.9
        • 0.2.4
        • 0.2.3
        • 0.2.2
        • 0.2.0
        • 0.1.11
        • 0.2.7
        • 0.3.0
        • 0.1.5
        • 0.1.4
        • 0.1.6
  • Docs
  • Get started
      • Self hosted
      • In browser
    • Identity
      • Quick start
      • Production ready
      • React
      • Create React App
      • Vue
        • Introduction
        • Postgres setup
        • NodeJS Identity
        • React frontend
        • Introduction
        • Deploy the Query Engine
        • Dynamic Data Set
  • Dashboard
      • Core
      • identity
      • queryEngineEndpoint
      • dataSets
      • data
      • runQueries
      • queryEngineConfig
      • Multiple dashboards
      • dashboardId
      • parentDashboardId
      • Customization
      • theme
        • Accordion
        • Buttons
        • Charts
        • Dashboard
        • Dropdowns
        • Forms
        • Library
        • Modals
        • Notifications
        • Lists
        • Panels
        • Tables
        • Tabs
        • Live Examples
      • featureToggles
      • textOverrides
      • Icons
      • Component overrides
      • dataPanel
      • formatPanel
      • excludeComponents
      • includeComponents
      • developerTools
      • maxCSVDownloadLimit
      • numberFormatOptions
      • organizationName
      • Event handlers
      • onEditorUpdate
      • onViewClick
      • onDashboardFilterChange
      • Filters
      • dateFilterOptions
      • dashboardFilters
      • cascadeFilterSelection
      • Scheduled Reporting
      • reportScheduleOptions
    • Theme and experience
    • Management
    • Distribution
    • Log level
    • CSS
    • Libraries
    • Vue
    • HTML
    • Svelte
    • Angular
    • Self-hosted
      • Integrations
        • Snowflake
        • MariaDB
        • MySQL
        • Postgres
        • BigQuery
        • Local
        • Amazon Web Services
        • Google Cloud Platform
        • Heroku
      • Config
        • Config manager
        • Storage
          • Vizzly API
          • GitHub
          • AWS S3
          • BigQuery
          • MariaDb
          • MySQL
          • Postgres
          • Snowflake
      • Environment variables
      • Log level
      • Performance
      • SSL termination
      • GitHub Actions CI
        • Headers
        • Create Results
    • Custom
      • Query
      • Result
    • In-browser
    • Compare
  • Identity and Multi-Tenancy
    • Node client
    • Python client
    • Self sign
    • Load your private key from an environment variable
  • Webhooks
    • Get started
    • Scheduled reports
    • Parent & child dashboards
    • Identity Config
      • Access type
      • User reference
      • Database schema access
      • Secure filters
      • Scope
      • Data sets
      • Parent dashboard IDs
      • Project Id
      • Project Resources
    • Data set
    • Time format
    • Data type
    • Field
    • Verified views
    • View attributes
    • Query
    • Result
  • Architecture
  • Vizzly CLI
  • Key Pair
  • Parameters
  • Developer Support
        • 0.4.19
        • 0.4.18
        • 0.4.16
        • 0.4.13
        • 0.4.11
        • 0.4.9
        • 0.4.8
        • 0.4.7
        • 0.4.5
        • 0.4.4
        • 0.4.3
        • 0.4.0
        • 0.3.33
        • 0.3.31
        • 0.3.30
        • 0.3.29
        • 0.3.27
        • 0.3.25
        • 0.3.22
        • 0.3.21
        • v0.6.5
        • v0.6.4
        • v0.6.2
        • v0.6.1
        • v0.6.0
        • v0.5.3
        • v0.5.2
        • V0.6.6
        • V0.6.7
        • V0.6.8
        • V0.6.9
        • 0.2.4
        • 0.2.3
        • 0.2.2
        • 0.2.0
        • 0.1.11
        • 0.2.7
        • 0.3.0
        • 0.1.5
        • 0.1.4
        • 0.1.6

On This Page

  • Query engine
Get started

Get started

Vizzly CLI

To get started, sign in to your Vizzly account (opens in a new tab), and visit the CLI authentication page (opens in a new tab). On that page, you will find two CLI commands, one to install the Vizzly CLI, and the other to authenticate the CLI. After running those commands, return here to continue the setup process.

Query engine

Now you have the CLI set up, pick one of the following Query Engines to continue!

  • Self-Hosted
  • In-Browser
DocsSelf hosted