VAST Catalog CLI Quick Start Guide

  • Updated on Feb 4, 2026
  • Published on Jan 28, 2026
  • 1 minute(s) read
Prev Next

Note

This procedure is not yet finalized. Please watch for further updates.

Follow the steps below to get started using VAST Catalog CLI.

System Requirements

  • Unix system

  • Docker installed

  • Network access to VAST Cluster

Obtain Access Credentials

Obtain the following from your VMS administrator:

  • S3 access key pair

  • Host IP(s). This should be one or more IPs belonging to one of the cluster's VIP pools.

Install

  1. Download the image from the Docker repository: 

    docker pull vastdataorg/vast-db-cli:4.7.0

    Note

    If you cannot pull from Docker, you can download a tar file with the image instead.

  2. Download vast-db-cli from the VAST Catalog CLI repository.

  3. Do one of the following:

    • Move vast-db-cli into the bin/ directory.

    • Make vast-db-cli executable: chmod +x vast-db-cli

  4. Execute the script.

    The VAST Catalog CLI is now installed.

Configure

To start using the VAST Catalog CLI, run the vast-db-cli configure command:

$ vast-db-cli configure
    Access Key: <access-key>
    Secret Access Key: <secret-key>
    Host IP: <Host IPs>
    Port: 80

Specify <Host IPs> as a comma separated list of IPs, or one IP.

VAST Catalog is now installed and configured.

Getting Help

For information about how to use the VAST Catalog CLI, run the following command:

$ vast-db-cli --help

Related articles