visivo
Usage:
visivo [OPTIONS] COMMAND [ARGS]...
Options:
-p, --profile
-e, --env-file TEXT
--version Show the version and exit.
--help Show this message and exit.
aggregate
Usage:
visivo aggregate [OPTIONS]
Options:
-o, --output-dir TEXT Directory to output results
-j, --json-file TEXT The file with the raw json results from the query
--help Show this message and exit.
archive
Archives a stage. You must specify a stage when deploying a project.
Usage:
visivo archive [OPTIONS]
Options:
-s, --stage TEXT The stage of the project to deploy i.e. staging
[required]
-h, --host TEXT Host to deploy to
-u, --user-dir TEXT Directory containing profile
--help Show this message and exit.
authorize
Handles the authorization process.
Checks for an existing token, and if the user chooses to add a
new token, starts a Flask server (listening for a callback on
http://localhost:5001/authorize-device-token). It then opens an external webapp
(at
The process will wait for up to CALLBACK_RESPONSE_WAIT_TIME seconds for the callback. If the callback is not received, you will be prompted to cancel or continue waiting.
Usage:
visivo authorize [OPTIONS]
Options:
-h, --host TEXT Host to deploy to
--help Show this message and exit.
compile
Parses the files in your working directory, extracting visivo configurations and then using those configurations to build the trace queries and a project.json file in your source directory. Queries are not run on compile, just written.
Usage:
visivo compile [OPTIONS]
Options:
-s, --source TEXT Name of the default source connection to use. This
overrides the default source in the project.
-w, --working-dir TEXT Directory to run the command
-o, --output-dir TEXT Directory to output results
-dp, --dbt-profile TEXT The dbt profile to use
-dt, --dbt-target TEXT The dbt target to use
--help Show this message and exit.
create
Enables a quick set up by writing your source & api credentials to an env file.
Usage:
visivo create [OPTIONS]
Options:
--project-name TEXT The name of the project to initialize
--help Show this message and exit.
dbt
Refreshes the dbt objects in the for use in Visivo.
Usage:
visivo dbt [OPTIONS]
Options:
-w, --working-dir TEXT Directory to run the command
-o, --output-dir TEXT Directory to output results
-dp, --dbt-profile TEXT The dbt profile to use
-dt, --dbt-target TEXT The dbt target to use
--help Show this message and exit.
deploy
Sends the current version of your project, traces & data to app.visivo.io where it can be viewed by other users on your account. You must specify a stage when deploying a project. The stage allows multiple versions of your project to exist remotely. This is very useful for setting up different dev, CI and production environments.
Usage:
visivo deploy [OPTIONS]
Options:
-w, --working-dir TEXT Directory to run the command
-o, --output-dir TEXT Directory to output results
-s, --stage TEXT The stage of the project to deploy i.e. staging
[required]
-h, --host TEXT Host to deploy to
-u, --user-dir TEXT Directory containing profile
--help Show this message and exit.
dist
Creates a distributable version of this dashboard and stores it in a 'dist' folder. This folder can be statically deployed to any web server, hosting service, or bucket storage.
Note: Make sure to run visivo run before running visivo dist.
Usage:
visivo dist [OPTIONS]
Options:
-o, --output-dir TEXT Directory to output results
-d, --dist-dir TEXT Directory to output the distribution files
--help Show this message and exit.
init
Enables a quick set up by writing your source & api credentials to an env file.
Usage:
visivo init [OPTIONS]
Options:
-pd, --project-dir TEXT Directory to initialize the project in
--help Show this message and exit.
install
Install required dependencies for Visivo.
Usage:
visivo install [OPTIONS]
Options:
--help Show this message and exit.
run
Compiles the project and then runs the trace queries to fetch data to populate in the traces. Writes all data to the source directory. Can skip the compile with the --skip-compile flag.
Usage:
visivo run [OPTIONS]
Options:
-w, --working-dir TEXT Directory to run the command
-o, --output-dir TEXT Directory to output results
-df, --dag-filter TEXT Run the command with the given dag filter.
ie `-df 'dashboard-name'+` will only run the
dashboard named 'dashboard-name' and it's
children
-s, --source TEXT Name of the default source connection to
use. This overrides the default source in
the project.
-th, --threads TEXT The max number of threads to use when
running trace queries
-dp, --dbt-profile TEXT The dbt profile to use
-dt, --dbt-target TEXT The dbt target to use
-sc, --skip-compile Skips the compile phase. This is useful if
you have already compiled just want to run
or serve.
-tm, --thumbnail-mode [none|missing|all]
Mode for thumbnail generation: 'none' to
disable, 'missing' to generate only missing
thumbnails, 'all' to generate all
thumbnails, 'refresh' to force regeneration
of all thumbnails
-p, --port INTEGER What port to serve on
--help Show this message and exit.
serve
Enables fast local development by spinning up a localhost server to run and view your project locally. Visivo will automatically refresh your project and re-run traces that have changed when you make updates to project files.
Usage:
visivo serve [OPTIONS]
Options:
-s, --source TEXT Name of the default source connection to
use. This overrides the default source in
the project.
-w, --working-dir TEXT Directory to run the command
-o, --output-dir TEXT Directory to output results
-df, --dag-filter TEXT Run the command with the given dag filter.
ie `-df 'dashboard-name'+` will only run the
dashboard named 'dashboard-name' and it's
children
-p, --port INTEGER What port to serve on
-tm, --thumbnail-mode [none|missing|all]
Mode for thumbnail generation: 'none' to
disable, 'missing' to generate only missing
thumbnails, 'all' to generate all
thumbnails, 'refresh' to force regeneration
of all thumbnails
-th, --threads TEXT The max number of threads to use when
running trace queries
-sc, --skip-compile Skips the compile phase. This is useful if
you have already compiled just want to run
or serve.
-dp, --dbt-profile TEXT The dbt profile to use
-dt, --dbt-target TEXT The dbt target to use
--help Show this message and exit.
test
Enables testing trace values to ensure that the charts that are being produced have the characteristics that you would expect.
Usage:
visivo test [OPTIONS]
Options:
-s, --source TEXT Name of the default source connection to use. This
overrides the default source in the project.
-w, --working-dir TEXT Directory to run the command
-o, --output-dir TEXT Directory to output results
--help Show this message and exit.