Skip to content

visivo

Usage:

visivo [OPTIONS] COMMAND [ARGS]...

Options:

  -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.

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 target directory. Queries are not run on compile, just written.

Usage:

visivo compile [OPTIONS]

Options:

  -t, --target TEXT        Name of the default target connection to use. This
                           overrides the default target in the project.
  -w, --working-dir TEXT   Directory to run the command
  -o, --output-dir TEXT    Directory to output results
  -nf, --name-filter TEXT  Run the command to only include the dag that
                           includes the node with the given name
  --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.

Usage:

visivo dist [OPTIONS]

Options:

  -t, --target TEXT        Name of the default target connection to use. This
                           overrides the default target in the project.
  -w, --working-dir TEXT   Directory to run the command
  -o, --output-dir TEXT    Directory to output results
  -d, --dist-dir TEXT      Directory to output the distribution files
  -nf, --name-filter TEXT  Run the command to only include the dag that
                           includes the node with the given name
  -th, --threads INTEGER   The max number of threads to use when running trace
                           queries
  --help                   Show this message and exit.

init

Enables a quick set up by writing your target & api credentials to an env file.

Usage:

visivo init [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 target directory.

Usage:

visivo run [OPTIONS]

Options:

  -t, --target TEXT        Name of the default target connection to use. This
                           overrides the default target in the project.
  -w, --working-dir TEXT   Directory to run the command
  -o, --output-dir TEXT    Directory to output results
  -nf, --name-filter TEXT  Run the command to only include the dag that
                           includes the node with the given name
  -th, --threads INTEGER   The max number of threads to use when running trace
                           queries
  --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:

  -t, --target TEXT        Name of the default target connection to use. This
                           overrides the default target in the project.
  -w, --working-dir TEXT   Directory to run the command
  -o, --output-dir TEXT    Directory to output results
  -nf, --name-filter TEXT  Run the command to only include the dag that
                           includes the node with the given name
  -p, --port INTEGER       What port to serve on
  -th, --threads INTEGER   The max number of threads to use when running trace
                           queries
  --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:

  -t, --target TEXT       Name of the default target connection to use. This
                          overrides the default target in the project.
  -w, --working-dir TEXT  Directory to run the command
  -o, --output-dir TEXT   Directory to output results
  -a, --alert TEXT        Name of the alert to use
  --help                  Show this message and exit.