How to Install Catalyst CLI ?

The Catalyst CLI lets you build, test and deploy your Zoho Catalyst apps from your local machine, whether you are working with serverless functions, SmartBrowz automation or Cloud Scale services. It works in your project’s development environment, so changes made with the CLI do not affect your live app until you explicitly deploy them. The CLI is supported on Windows, macOS and Linux, with the same installation process on each.

Check the prerequisites

Node.js and NPM

The Catalyst CLI is installed using NPM or Yarn, so you need Node.js (version 14 or later) and NPM installed first. Check whether they are already installed by running node -v and npm -v. If not, download Node.js from its official website, or use a version manager such as NVM. NPM is bundled with Node.js, so installing Node covers both.

Programming language environments (optional)

If you plan to write functions in these languages, install the environment you need:

• Java: install JDK version 8, 11 or 17.
• Python: install Python 3.10, with Pip available (Pip is included with the official installer).

Only install the environments for the languages you plan to use.

Install the Catalyst CLI

Open your terminal with admin privileges: on Windows, right-click and choose Run as Administrator; on macOS or Linux, add sudo before the command.

Install via NPM:

npm install -g zcatalyst-cli

Or using Yarn:

yarn add zcatalyst-cli