Zoomdata Version

Commands for the Custom Chart CLI

You can access a list of command commands at any time by running zd-chart [options] [command].

Common commands

Command Usage
add Adds a chart or library to the Zoomdata server
config Sets up an encrypted configuration of the servers URL and credentials
create Creates a new custom chart on the server
edit Edits the chart's controls, components, libraries, variables, etc
ls Lists the custom charts
pull Pulls the latest version of a custom chart from the server
push Pushes the current state of the chart to the server
rm Removes a custom chart or library from the server
watch Watches the changes in custom chart files and updates them

Common Examples

Add

zd-chart-add [options] <name> <filepath>

Options

  • -a, --app [URL] Specify the Zoomdata application server URL (e.g. https://myserver/zoomdata)
  • -t, --type [chart|library] Set the type of object to add. Valid options: "chart (default)", "library" (default: chart)
  • -u, --user [user:password] Specify the user name and password to use for server authentication.
  • -h, --help output usage information

Config

zd-chart-config

Parameters

  • server (ex. http://myserver.com:8080/zoomdata)
  • user name
  • password

Create

zd-chart-create

Options

  • -a, --app [URL] Specify the Zoomdata application server URL (e.g. https://myserver/zoomdata)
  • -u, --user [user:password] Specify the user name and password to use for server authentication.
  • -h, --help output usage information

Edit

zd-chart-edit <chartname>

You can edit the following elements:

  • Components
  • Controls
  • Libraries
  • Name
  • Variables
  • Visibility

Pull

zd-chart-pull [options] [chartname]

Options

  • -a, --app [URL] Specify the Zoomdata application server URL (e.g. https://myserver/zoomdata)
  • -d, --dir [path/to/store/visualization] Store the custom chart in the specified directory
  • -u, --user [user:password] Specify the user name and password to use for server authentication
  • --zip Pull the custom chart in a zip file format
  • -h, --help output usage information

Push

zd-chart-push [options]

Options

  • -a, --app [URL] Specify the Zoomdata application server URL (e.g. https://myserver/zoomdata)
  • -d, --dir [path/to/source/files] Directory used to look for the chart to push.
  • -u, --user [user:password] Specify the user name and password to use for server authentication.
  • -h, --help output usage information

RM

zd-chart-rm [options] 

Options

  • -a, --app [URL] Specify the Zoomdata application server URL (e.g. https://myserver/zoomdata)
  • -t, --type [chart|library] Set the type of object to remove. Valid options: "chart (default)", "library (default: chart)
  • -u, --user [user:password] Specify the user name and password to use for server authentication.
  • -h, --help output usage information

Watch

zd-chart-watch [options]

Options

  • -a, --app [URL] Specify the Zoomdata application server URL (e.g. https://myserver/zoomdata)
  • -d, --dir [path/to/source/files] Directory used to look for the chart to watch.
  • -u, --user [user:password] Specify the user name and password to use for server authentication.
  • -h, --help output usage information

Was this topic helpful?