zapier

Connect to a Zapier account

$ zapier login

$ zapier init [path/to/directory]

$ zapier scaffold [trigger|create|search|resource] [name]

$ zapier test

$ zapier push

$ zapier help

$ zapier help [command]

zapier <command> [options]
zapier init
zapier login
zapier push
zapier deploy
zapier help [command]

login
    Authenticates the CLI with your Zapier developer account, typically via an OAuth flow.

init
    Initializes a new Zapier app project in the current directory, setting up the basic file structure.

push
    Uploads the local app definition and code to Zapier for testing on the platform. This creates a private version of your app.

deploy
    Deploys a new, public version of your Zapier app to the platform, making it available for users.

test
    Runs local unit and integration tests against your app's code to ensure functionality.

validate
    Checks your app's definition for common errors and adherence to Zapier's platform guidelines.

logs
    Streams runtime logs from your deployed app on Zapier for debugging purposes.

env
    Manages environment variables for your Zapier app, useful for sensitive data or configuration.

shell
    Opens an interactive shell environment for direct testing and debugging of app actions and triggers.

--version, -v
    Displays the installed version of the Zapier CLI.

--help, -h
    Displays help information for the main command or a specific subcommand.

The zapier command-line interface (CLI) is a powerful tool designed for developers to interact with the Zapier platform. Zapier itself is a web-based service that allows end-users to automate workflows by connecting different web applications without writing code. The zapier CLI extends this capability to developers, enabling them to build, test, and deploy custom integrations (known as 'Apps' or 'Connectors') directly from their development environment.

This allows for more complex, tailored automation scenarios that might not be possible with Zapier's visual interface alone. Developers use the CLI to initialize new projects, manage authentication, push updates, test app functionality, and deploy new versions of their integrations to the Zapier platform. It streamlines the development lifecycle for custom Zapier integrations, making it an essential tool for extending Zapier's capabilities.

The zapier command is not a standard Linux utility; it must be installed separately, typically via a Node.js package manager like npm or yarn. It requires an active internet connection and a Zapier developer account for most of its functionalities, as it interacts directly with Zapier's cloud platform. Its primary use case is for developers building custom integrations, not for general Zapier end-users.

The zapier CLI requires authentication with a Zapier developer account. This is typically done using the zapier login command, which guides the user through an OAuth flow to link their local CLI session to their Zapier account. This authentication is crucial for pushing, deploying, and managing apps on the Zapier platform.

A typical development workflow using the zapier CLI involves initializing a new project (zapier init), developing app functionality locally, iteratively testing changes (zapier test), pushing updates to a private test version on Zapier (zapier push), and finally deploying (zapier deploy) a stable version for wider use on the Zapier platform.

The Zapier CLI, often referred to as zapier-platform-cli, was developed by Zapier to provide a robust command-line interface for their Zapier Platform. Its development closely parallels the evolution of Zapier's developer platform, which allows third-party developers to extend Zapier's automation capabilities by creating custom apps. It was introduced to facilitate a more streamlined and programmatic approach to building, testing, and deploying these integrations, moving beyond just visual configuration. Its ongoing development reflects Zapier's commitment to empowering developers within its ecosystem.

npm(1), node(1), git(1), curl(1)