Installation

Install watsonx.ai Flows Engine

To install watsonx.ai Flows Engine you need to follow a couple of steps, starting with selecting your programming language of choice. See here for the differences between the two versions.

Prerequisite: You need to have Node.js v18 or higher installed on your local machine.

• Download the CLI using the button below:

  Log in / Sign up to download CLI

• Run the following command from the directory you've downloaded the file

  wxflows-2.0.0.tgz
  Copy to clipboard to:

  npm i -g ./wxflows-2.0.0.tgz

  Copy to clipboard

  ⚠️ You cannot have both the Python and Node.js CLI installed globally. Either remove the Python CLI or install the Node.js CLI without the

  -g
  Copy to clipboard flag, and use npx (like
  npx wxflows ...
  Copy to clipboard) to run your commands.

  This will install the latest version of the CLI from the downloaded

  .tgz
  Copy to clipboard file.

• After installing the CLI you can verify that it's installed correctly as follows:

  wxflows --version

  Copy to clipboard

  This should return something like

  wxflows 2.0.0
  Copy to clipboard.

You can now proceed to the next section.

Which CLI should I use?

You can use either the Python or Node.js version of the CLI, but there are slight differences between the two. Currently, the Python CLI is recommended for doing Retrieval Augmented Generation (RAG) and building flows; while the Node.js CLI works best for tool calling.