Downloading and installing IBM Cloud Pak for Data Command Line Interface (IBM cpdctl)

This topic provides information on how to download, install, and verify the IBM Cloud Pak for Data Command Line Interface (IBM cpdctl), with a focus on the watsonx.data (wx-data) plugin.

watsonx.data on IBM Software Hub

watsonx.data on IBM Cloud®

Before you begin

You can learn more about IBM cpdctl from the official README file.

Procedure

Download and install IBM cpdctl using one of the following 2 methods:

Option 1: Run the following command to automatically download and install the IBM cpdctl, detecting the operating system and processor architecture for Linux and macOS:

platform=$(uname -s | tr '[A-Z]' '[a-z]')
arch=$(uname -m | sed 's/x86_64/amd64/')
curl -LOs "https://github.com/IBM/cpdctl/releases/latest/download/cpdctl_${platform}_${arch}.tar.gz"
tar zxf cpdctl_${platform}_${arch}.tar.gz

Option 2: Download the appropriate archive from IBM cpdctl repository.

Note: IBM cpdctl for Windows operating system can be downloaded from the archive.

Table 1. Downloadable files for various operating systems
Operating system	Archive name	Comments
Microsoft Windows x64	cpdctl_windows_amd64.zip	Use the Windows Explorer to extract `cpdctl.exe` from the archive.
Linux x64	cpdctl_linux_amd64.tar.gz	Issue command `$ tar zxf cpdctl_linux_amd64.tar.gz` to extract the cpdctl executable from the archive.
Linux Power 64 bit LE	cpdctl_linux_ppc64le.tar.gz	Issue command `$ tar zxf cpdctl_linux_ppc64le.tar.gz` to extract the cpdctl executable from the archive.
Linux on IBM Z	cpdctl_linux_s390x.tar.gz	Issue command `$ tar zxf cpdctl_linux_s390x.tar.gz` to extract the cpdctl executable from the archive
macOS - Intel x64	cpdctl_darwin_amd64.tar.gz	Issue command `$ tar zxf cpdctl_darwin_amd64.tar.gz` to extract the cpdctl executable from the archive
macOS - Apple silicon	cpdctl_darwin_arm64.tar.gz	Issue command `$ tar zxf cpdctl_darwin_arm64.tar.gz` to extract the cpdctl executable from the archive.

Table 2. Supported `cpdctl` versions
watsonx.data version	`cpdctl` version
v2.1.1	v1.6.95 and later
v2.1.1 (Developer edition)	1.6.104 and later
v2.1.2	v1.7.0 and later

Run ./cpdctl in the terminal to verify if cpdctl is installed successfully and to display the supported commands.

Result is:

NAME:
  cpdctl - IBM Cloud Pak for Data Command Line Interface

USAGE:
   cpdctl [command] [options]

COMMANDS:
  config         Manage Configuration
  asset          Manage Assets
  project        Manage Watson Studio - Projects API - OpenAPI Docs.
  space          Manage Spaces
  connection     Manage IBM Watson Data Platform Connections service.
  environment    Manage Environments and Runtimes API.
  notebook       Manage Notebooks API.
  code-package   Manage Code Packages API.
  job            Manage IBM Watson Data Platform Jobs and Scheduling Service.
  ml             Manage Watson Machine Learning.
  datastage      Manage IBM APIs for DataStage.
  find           Find a resource with CPD Path
  pipeline       Manage IBM Orchestration Pipelines API.
  wx-ai          Manage watsonx.ai.
  version        Display the tool version

OPTIONS:
      --cpd-config string   Configuration file path
      --cpdconfig string    [Deprecated] Use --cpd-config instead
  -h, --help                Show help
      --profile string      Name of the configuration profile to use
      --raw-output          If set to true, single values in JSON output mode are not surrounded by quotes
  -v, --version             Version of the plugin.

Use "cpdctl service-command --help" for more information about a command.

Run the following command to set the environment variable to enable watsonx.data plugin, if wx-data command is not listed in different operating systems.

Note: From watsonx.data 2.1.2 version and later, wx-data is available in IBM cpdctl by default. Therefore, you need not run this command from 2.1.2 version and later.
For macOS and Linux:
```
export CPDCTL_ENABLE_WATSONX_DATA=true
```
For Windows Command Prompt:
```
set CPDCTL_ENABLE_WATSONX_DATA=true
```
For Windows PowerShell:
```
$env:CPDCTL_ENABLE_WATSONX_DATA = $true
```

Run ./cpdctl after enabling watsonx.data plugin to verify that watsonx.data is enabled.

Result is:

NAME:
  cpdctl - IBM Cloud Pak for Data Command Line Interface

USAGE:
   cpdctl [command] [options]

COMMANDS:
  config         Manage Configuration
  asset          Manage Assets
  project        Manage Watson Studio - Projects API - OpenAPI Docs.
  space          Manage Spaces
  connection     Manage IBM Watson Data Platform Connections service.
  environment    Manage Environments and Runtimes API.
  notebook       Manage Notebooks API.
  code-package   Manage Code Packages API.
  job            Manage IBM Watson Data Platform Jobs and Scheduling Service.
  ml             Manage Watson Machine Learning.
  datastage      Manage IBM APIs for DataStage.
  find           Find a resource with CPD Path
  pipeline       Manage IBM Orchestration Pipelines API.
  wx-data        Manage watsonx.data.
  wx-ai          Manage watsonx.ai.
  version        Display the tool version

OPTIONS:
      --cpd-config string   Configuration file path
      --cpdconfig string    [Deprecated] Use --cpd-config instead
  -h, --help                Show help
      --profile string      Name of the configuration profile to use
      --raw-output          If set to true, single values in JSON output mode are not surrounded by quotes
  -v, --version             Version of the plugin.

Use "cpdctl service-command --help" for more information about a command.

For more information about the supported commands and the usage formats are available in the Supporting commands and usage for watsonx.data in IBM cpdctl CLI.