---
title: "Install the VAST DataEngine CLI tools"
slug: "install-the-vast-dataengine-cli-tools"
description: "Log into the DataEngine GUI, change your password, create S3 access keys, and configure Docker for seamless serverless function deployment."
tags: ["DataEngine"]
updated: 2026-10-28T02:14:35Z
published: 2026-10-28T02:14:35Z
canonical: "docs.vastdata.com/install-the-vast-dataengine-cli-tools"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vastdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the VAST DataEngine CLI tools

> [!NOTE]
> ℹ️ Info
> 
> **Outcome:** The vastde CLI is installed, authenticated, and able to query the VAST DataEngine environment.
> 
> **Before you begin:** Enable DataEngine on the tenant, install Docker, and have the tenant user’s temporary password available.
> 
> **Previous:** [Connect DataEngine to the Kubernetes Cluster and Registry](/develop/docs/connecting-vast-dataengine-to-kubernetes-cluster-and-registry) | **Next:** [Run a “Hello World” Pipeline](/develop/docs/run-a-hello-world-pipeline)

## Sign in to DataEngine and change the temporary password

> [!NOTE]
> ℹ️ Info
> 
> You must log into the GUI with your user and change the password prior to proceeding. You also must have an S3 key created in the tenant in order to use `vastde` cli.

1. Browse to your Tenant Dashboard https://<vms-ip>/#/login/<tenant name> (for example `https://10.143.12.206/#/login/de-lab-tenant`)
2. Sign in with the DataEngine username and temporary password from your lab worksheet
3. Change the temporary password to a unique password that meets your organization’s policy
4. Choose “Save Password”

![image-20260813-155226.png](https://cdn.us.document360.io/89b91113-5dc6-49db-86ec-57b16dc8ce56/Images/Documentation/image-20260813-155226.png?sv=2026-02-06&spr=https&st=2026-11-08T08%3A55%3A15Z&se=2026-11-08T09%3A55%3A15Z&sr=c&sp=r&sig=ohXkSIZEISVAktB70wqNrUArrCTk4kC9Q01eZoM2FqA%3D)

The DataEngine Tenant Dashboard will appear

> [!NOTE]
> ℹ️ Info
> 
> It may show “failure” when the page loads. Simply refresh and you should see the blank screen below.

![image-20260813-155407.png](https://cdn.us.document360.io/89b91113-5dc6-49db-86ec-57b16dc8ce56/Images/Documentation/image-20260813-155407.png?sv=2026-02-06&spr=https&st=2026-11-08T08%3A55%3A15Z&se=2026-11-08T09%3A55%3A15Z&sr=c&sp=r&sig=ohXkSIZEISVAktB70wqNrUArrCTk4kC9Q01eZoM2FqA%3D)

## Create S3 access keys

If you have not created an S3 access key for this user or if you need additional access keys:

Go to the User Menu in the upper right of the page.

![image-20260901-142227.png](https://cdn.us.document360.io/89b91113-5dc6-49db-86ec-57b16dc8ce56/Images/Documentation/image-20260901-142227.png?sv=2026-02-06&spr=https&st=2026-11-08T08%3A55%3A15Z&se=2026-11-08T09%3A55%3A15Z&sr=c&sp=r&sig=ohXkSIZEISVAktB70wqNrUArrCTk4kC9Q01eZoM2FqA%3D)

Choose “Manage Access Keys”

![image-20260901-142401.png](https://cdn.us.document360.io/89b91113-5dc6-49db-86ec-57b16dc8ce56/Images/Documentation/image-20260901-142401.png?sv=2026-02-06&spr=https&st=2026-11-08T08%3A55%3A15Z&se=2026-11-08T09%3A55%3A15Z&sr=c&sp=r&sig=ohXkSIZEISVAktB70wqNrUArrCTk4kC9Q01eZoM2FqA%3D)

Choose “Generate Another Key”.

- Copy the Access and Secret Keys and store them in a safe place.

Choose “Done” to return to the DataEngine Dashboard.

## Configure Docker

> [!NOTE]
> ℹ️ Info
> 
> Before you Proceed you will need Docker Desktop (Mac/PC) or docker.io (linux) installed. This guide does not cover that step. Podman is not currently supported.

Edit your docker `daemon.json` to set the `min-api-version` and to trust the insecure registry (if you have been following this series of guides)

### For Mac with Docker Desktop

Go to Settings-> Docker Engine

```json
{
  "min-api-version": "1.24",
  "builder": {
    "gc": {
      "defaultKeepStorage": "20GB",
      "enabled": true
    }
  },
  "experimental": false,
  "insecure-registries": [
    "10.144.19.8:5000"
  ]
}
```

### For Linux with `docker.io`

```bash
mkdir -p /etc/docker

sudo tee /etc/docker/daemon.json >/dev/null <<'EOF'
{
  "min-api-version": "1.24",
  "features": {
    "containerd-snapshotter": false
  },
  "storage-driver": "overlay2",
  "builder": {
    "gc": {
      "defaultKeepStorage": "20GB",
      "enabled": true
    }
  },
  "experimental": false,
  "insecure-registries": [
    "10.144.10.6:5000"
  ]
}
EOF

dockerd --validate --config-file=/etc/docker/daemon.json

sudo systemctl restart docker
sudo systemctl status docker --no-pager

sudo docker info | grep -A3 'Storage Driver'
sudo docker info | grep -A5 'Insecure Registries'
```

## Installing the Vast DataEngine CLI on your laptop or a development machine

`vastde` is a command-line tool for building serverless functions for the VAST DataEngine.

### Download and Install

Download the `vastde` binary for your platform from the [releases page](https://github.com/vast-data/dataengine-cli/releases), or use the instructions below.

#### macOS (Apple Silicon)

```plaintext
cd ~
curl -fsSL -o release_darwin_arm64.tar.gz https://github.com/vast-data/dataengine-cli/releases/download/v5.5.0-sp2/release_darwin_arm64.tar.gz
tar -xzvf release_darwin_arm64.tar.gz
cd release_darwin_arm64/
chmod +x vastde_darwin_arm64
sudo mv vastde_darwin_arm64 /usr/local/bin/vastde
```

#### Linux (x86_64)

```plaintext
cd ~
curl -fsSL -o release_linux_amd64.tar.gz https://github.com/vast-data/dataengine-cli/releases/download/v5.5.0-sp2/release_linux_amd64.tar.gz
tar -xzvf release_linux_amd64.tar.gz
cd release_linux_amd64/
chmod +x vastde_linux_amd64
sudo mv vastde_linux_amd64 /usr/local/bin/vastde
```

Linux (ARM64), macOS (Intel), and Windows x86_64 versions are also available.

### Verify Installation

Make note of the version of `vastde`

```plaintext
vastde version
```

Example Output

```plaintext
Cannot read config file: /Users/<username>/.vast/config.toml
Call 'vastde config init' to create a new config file
v5.4.3-sp4-hf21
```

### Configure the client to connect to your VAST Cluster

#### Initialize the configuration

```bash
vastde config init
```

Example Output

```plaintext
Cannot read config file: /Users/<username>/.vast/config.toml
Call 'vastde config init' to create a new config file
Created config file: /Users/<username>/.vast/config.toml
Configuration updated successfully!
```

#### Point the client to your VAST Cluster

Use the Vast VMS address for `--vms-url`

```bash
 vastde config set --vms-url https://10.143.12.206
```

Expected Output

```plaintext
Configuration updated successfully!
```

#### Set up Authentication Credentials

We will utilize the user we created earlier

`U: de-lab-user`

`P: &lt;dataengine-user-password&gt;` (remember the password was changed at login)

```bash
vastde config set --username de-lab-user --password <dataengine-user-password> --tenant de-lab-tenant
```

Expected Output

```plaintext
Configuration updated successfully!
```

#### Set up the Vast Builder Image URL

1. Go to [https://hub.docker.com/r/vastdataorg/vast-builder/tags](https://hub.docker.com/r/vastdataorg/vast-builder/tags)
2. find the image that matches your `vastde` version (for example `vastdataorg/vast-builder:v5.4.3-sp4-hf21`)

```bash
vastde config set --builder-image-url vastdataorg/vast-builder:v5.4.3-sp4-hf21
```

Expected Output

```plaintext
Configuration updated successfully!
```

#### Test the configuration

1. View the config

```bash
vastde config view
```

Example Output

```plaintext
Tenant Name: de-lab-tenant
Username: de-lab-user
Password: ***
Builder Image URL: vastdataorg/vast-builder:v5.4.3-sp4-hf21
VMS URL: https://10.143.12.206
```

1. Run a query with `vastde`

```bash
vastde compute-clusters list
```

Example Output

```plaintext
Compute Cluster     Description                          GUID                                    Updated at
-----------------------------------------------------------------------------------------------------------------
de-lab-rke2         None                                 45de65fb-1f32-4e09-87a4-077c4e6ef979    2026-08-12 17:33
```

## Verification

The CLI is ready when `vastde version` returns the installed version and `vastde compute-clusters list` returns the connected cluster.