Install the IBM watsonx Orchestrate ADK on your computer.

​
Installation prerequisites

  • Install the required software to enable the ADK installation:

    • Python: The programming language that the ADK is written in. The ADK requires at least Python 3.11, and the latest compatible version is Python 3.13. For more information, see Python.
    • Pip: Pip is Python’s package manager. In some operating systems, it’s included with Python’s installation. For more information, see Pip.

  • Optional: Create a virtual environment with venv to install the ADK. For more information, see venv --- Creation of virtual environments.

​
Installing the ADK

  1. Install the ADK with pip.

    [BASH]
    pip install ibm-watsonx-orchestrate

  2. Test the installation:

    [BASH]
    orchestrate --version

After installation, you can start using the ADK and its CLI. For more information on available commands and arguments, use the --help argument at the end of a command. For example: orchestrate --help.

Note: If you are running the ADK on Ubuntu, including WSL, Server, or Minimal editions, the net-tools package might not be installed by default. This package provides the ifconfig command, which some tools may require. To install it, run sudo apt install net-tools and restart the server if needed.