zcatalyst-cli-test-alpha v1.2.1
Zoho Catalyst CLI
This is the Catalyst Command Line Interface (CLI) Tool. They can be used to:
- Initialize your project and associate it with various components
- Create and manage your projects
- Interact with data in your Catalyst projects via console
- Deploy code and assets to your Catalyst projects
To get started with the Catalyst CLI, you can go through our documentation CLI documentation.
Installation
To install the Catalyst CLI, you first need to Sign Up to ZOHO.
Then you need to install Node.js and npm.
NOTE
Installing Node.js should install npm as well.
Once npm is installed, you can get Catalyst CLI via following command:
npm install -g zcatalyst-cli
This will provide you with the globally accessible catalyst
command.
NOTE : If you need to setup the cli in current directory alone use the same command without -g
option.
Commands
The command catalyst --help
lists all the available commands and catalyst <command> --help
shows more details for provided command (if exists).
Certain command are project specific and for it to work you must be inside a project directory or you can simply specify the project id via -p <project_id>
option.
List of the available commands:
Command | Description |
---|---|
login | Authenticate your CLI to access Catalyst Details. Requires access to a web browser. |
logout | Sign out of the Catalyst CLI. |
list | Print a list of all of your Catalyst projects. |
use | Set active Catalyst project and manage it. |
init | Setup a new Catalyst project or link existing project to the current directory. |
help | Display help information about the CLI or specific commands. |
deploy | Deploys your Catalyst project for that particular folder. |
console:cache | Starts a Nodejs shell where you can try out various catalyst cache commands. |
console:queue | Starts a Nodejs shell where you can try out various catalyst queue commands. |
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago