Import a Custom Chart Using the CLI

This applies to: Visual Data Discovery

To import a custom chart using the custom chart CLI:

Run the cmp-chart import command, specifying the path to the library. You can import visual zip files that were downloaded from the Manage Custom Charts page or a custom chart created with an older version of the CLI.

$ cmp-chart import [options] <visualname> <path-to-visual>

where <path-to-visual> is the relative path to the zip file containing the visual you want to import.

The following options are available:

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

Composer Custom Chart CLI version 1 only supports the use of vnd.composer.v3+json as the Content-Type for API routes.

A custom chart is bundled before it is pushed to the Symphony server. This creates a /dist directory containing the necessary files required to send the visual to the Symphony server. This /dist custom chart zip file is not compatible with the cmp-chart import command and cannot be imported using the Manage Custom Charts page in the UI. To import the /dist custom chart zip file, use the cmp-chart push command instead.