CLI Command Reference

Command Reference

You must have Catalyst CLI installed in your system to access the Catalyst commands. Refer to the Installing Catalyst CLI help page for the steps.


Command SyntaxUsage
-v, --versionOutput Catalyst CLI version number
-p,--project <name_or_project_id>Specify the Catalyst project to be used for a command
--token <token>Supply an authentication token for a command
-- verboseChange the log level to verbose for debugging purposes
-h, --helpOutput usage information


Command SyntaxUsage
login [options]Log the CLI in to your Zoho Catalyst account
whoamiPrint the email address of the user currently logged in
token:generate [options]Create a CLI token to be used in CI systems
token:listList all the available tokens created in this CLI
token:revoke <id>Revoke the token created in this CLI
project:listList the Catalyst projects you have access to
project:use[options] [name_or_project_id]Set an active Catalyst project for your working directory
project:resetClear an active project selection and reset to the base project
init [options][feature]Initialize a Catalyst project in the current directory
pull [feature]Pull an existing project from Catalyst
ds:import [~CSV_file_path][options]Bulk write records to a table in the Catalyst Data Store
ds:export [options]Bulk read records from a table the Catalyst Data Store
ds:status [options]<operation>[job_id]Display the job status of a Data Store import or export operation
client:setupSetup, configure, and deploy the client files
client:deleteDelete specific versions of the client from the remote console
functions:setupSetup, configure, and deploy the function files for Catalyst Functions
functions:addAdd a function of the required stack to Catalyst Functions
functions:shell [options]Launch a node shell with emulated functions of any stack for development or production environments
functions:deleteDelete specific functions from the remote console
event:generate | generate:event [options] <source> <action>Generate sample payloads from different event sources of Catalyst
serve [options]Serve your code for local testing without affecting production
deploy [options]Deploy your code to your Catalyst project
run-script | run [command]Run a particular command script
help [command]Display help information
logoutLog the CLI out of your Zoho Catalyst account

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: