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:
Run the following command from the directory you've downloaded the file
to:npm i -g ./wxflows-2.0.0.tgz
⚠️ 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
flag, and use npx (like ) to run your commands.This will install the latest version of the CLI from the downloaded
file.After installing the CLI you can verify that it's installed correctly as follows:
wxflows --version
This should return something like
.
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.
Python CLI | Node.js CLI (recommended) | |
---|---|---|
Retrieval Augmented Generation (RAG) | ✅ | ⏳ TBD |
Tool Calling |
|
|
Flow language | ✅ | ⏳ TBD |