The Zapier Platform CLI (Command Line Interface) is a toolset you install and run in your local development environment. It allows you to build, test, and manage your Zapier integration through JavaScript code and terminal commands.
convert
command to create a CLI version of your project locallycd
into it. Then run:
zapier convert {your integration id} . --version={integration version you want to convert}
Your integration ID can be found in the browser location bar in the Platform UI:
zapier convert 1234 . --version=1.0.0
.zapierapprc
file).
A couple of important notes before deploying:
package.json
file. When you created your project with the convert
tool we automatically incremented the version you converted. You can change this to a different version number depending on your needs, but make sure a version with that number doesn’t already exist in your integration. Run zapier versions
from your project directory to see what’s already been created.zapier convert
command will include convertedByCLIVersion
in the package.json
for informational purposes.zapier push
When that completes you’ll be able to see the new version in the Platform UI in the Manage > Versions section, and will be able to make Zaps with your new CLI-built version.
You will not be able to edit your new CLI-built version from the Build section of the Platform UI, the attributes of this version will all show a lock icon.
You can still use all the other functions of the Platform UI, though, including version management, embed management and your Partner Dashboard. Your earlier versions, created within the Platform UI, are also still available and can still be edited and used.
If you decide that the Platform CLI is not for you, you can delete your new version from Manage > Versions and continue where you left off in the Platform UI.