Zoomdata Version

Commands for the Custom Chart CLI

You can access a list of command commands at any time by running zd-chart. For help on any command, simply enter its name or enter zd-chart help. For example, entering zd-chart init without any parameters will show the help for the zd-chart init command.

Common commands

Command Usage
config Sets up an encrypted configuration of the servers URL and credentials
edit Edits the chart's controls, components, libraries, variables, etc. Updates are not automatically pushed to the serve
import Imports a chart in a zip file.
init Creates a new chart in a folder you specify
ls Lists the custom charts
push Pushes the bundled format 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

Syntax

zd-chart config

$ zd-chart config <options>

Defines an encrypted configuration of Zoomdata's server URL and admin credentials.

Parameters

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

Options

  • -h, --help output usage information

zd-chart edit

$ zd-chart edit <chartname>

Edits a Zoomdata custom chart.

You can edit the following elements:

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

zd-chart import

$ zd-chart import <options> <chartname> <filepath>

Imports a custom chart to the Zoomdata server.

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

zd-chart init

$ zd-chart init <options> <path-to-chart>

Creates a custom chart.

Options

  • -t, --type <type> Specify the chart type. Valid values are single-group, multi-group, or raw. The default is single-group.
  • -h, --help output usage information

zd-chart ls

$ zd-chart ls <options>

Lists the custom charts you have created.

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

zd-chart push

$ zd-chart push [options]

Pushes a custom chart in its current state to the Zoomdata server.

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

zd-chart rm

$ zd-chart rm [options] 

Removes a custom chart from the Zoomdata server.

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

zd-chart watch

$ zd-chart watch [options]

Watches for changes in custom chart files and updates them in the Zoomdata server.

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?