How to Install Catalyst CLI ?

Estimated reading: 3 minutes 100 views

Introduction

Catalyst CLI is a handy tool that lets you build, test, and deploy your Catalyst apps right from your local machine. Whether you’re working with serverless functions, SmartBrowz automation, or Cloud Scale services, the CLI helps manage it all from the command line.

 

It works in your Catalyst project’s development environment, meaning any changes you make using the CLI won’t affect your live (production) app until you explicitly deploy them there.

 

Catalyst CLI is supported on Windows, macOS, and Linux, and the installation process is the same across all platforms.

Step-by-Step Instructions

  1. Check the Prerequisites

Before installing Catalyst CLI, make sure the following tools are ready on your system:

 

 Node.js & NPM

 

Catalyst CLI is installed using NPM or Yarn, so you’ll need Node.js (v14 or later) and NPM installed first.

To check if they’re already installed, run:

node -v

npm -v

If they’re not installed:

 NPM comes bundled with Node.js, so installing Node will cover both.

 

 Programming Language Environments (Optional, based on your needs)

 

If you plan to write functions in Catalyst CLI, install the language environments you’ll be using:

  • Node.js: Already covered above!
  • Java: Install JDK version 8, 11, or 17.
  • Python: Install Python 3.9 and make sure Pip is available (Pip is included if you use the official installer).

Only install the environments you need based on the language you plan to use.

 

  1. Install Catalyst CLI

Now you’re ready to install the CLI!

Open your terminal with admin privileges:

  • On Windows: Right-click and choose Run as Administrator
  • On macOS/Linux: Add sudo before the command

To install via NPM:

npm install -g zcatalyst-cli

Or, using Yarn:

yarn add zcatalyst-cli

After installation is complete, the CLI will display these details.

 

Once the installation is complete, verify it worked using the following command,
catalyst –version

You should see the installed version number. That means the CLI is ready to use!

 

 

  1. Update Catalyst CLI (When Needed)

The CLI will let you know when a new version is available.

 

To update:

 

npm install -g zcatalyst-cli

 

 If you’re having trouble updating, specify the version explicitly:

 

npm install -g zcatalyst-cli@1.9.0

Still not working? Try adding sudo (on macOS/Linux):

sudo npm install -g zcatalyst-cli

Tips

  • Always use Node.js version 14 or higher.
  • Use the CLI only in the development environment unless you’re ready to go live.
  • Keep your CLI updated to access the latest features and bug fixes.
  • Check the CLI Documentation for command references and usage examples.

Related Articles

Getting Started - Previous Getting Started with Catalyst Next - Getting Started What is Catalyst Projects ?

Recently Viewed articles

Leave a Reply

Your email address will not be published. Required fields are marked *

Learn how we helped 100 top brands gain success