@zapier/zapier-sdk-cli

@zapier/zapier-sdk-cli

Table of Contents

• Installation
• Quick Start
• Global Options
• Available Commands
• Accounts
  • get-profile
  • login
  • logout
• Actions
  • get-action
  • get-input-fields-schema
  • list-actions
  • list-input-field-choices
  • list-input-fields
  • run-action
• Apps
  • get-app
  • list-apps
• Authentications
  • find-first-authentication
  • find-unique-authentication
  • get-authentication
  • list-authentications
• HTTP Requests
  • request
• Utilities
  • add
  • build-manifest
  • bundle-code
  • generate-app-types
  • get-login-config-path
  • mcp

Installation

npm install -D @zapier/zapier-sdk-cli

Quick Start

# See all available commands
npx zapier-sdk --help

# Login to Zapier
npx zapier-sdk login

# List all available apps
npx zapier-sdk list-apps

# Generate TypeScript types for an app
npx zapier-sdk add slack --types-output ./types/slack.ts

Global Options

These options are available for all commands:

Option	Short	Description
--version	-v	Display version number
--help	-h	Display help for command
--debug		Enable debug logging
--json		Output raw JSON instead of formatted results

Available Commands

The CLI automatically generates commands from the SDK registry. All SDK functions are available as CLI commands using kebab-case naming.

Accounts

get-profile

Get current user's profile information

Usage:

npx zapier-sdk get-profile

login

Log in to Zapier to access your account

Options:

Option	Type	Required	Default	Possible Values	Description
--timeout	string	❌	—	—	Login timeout in seconds (default: 300)

Usage:

npx zapier-sdk login [--timeout]

logout

Log out of your Zapier account

Usage:

npx zapier-sdk logout

Actions

get-action

Get detailed information about a specific action

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key (e.g., 'SlackCLIAPI' or slug like 'github')
<action-type>	string	✅	—	read, read_bulk, write, run, search, search_or_write, search_and_write, filter	Action type that matches the action's defined type
<action-key>	string	✅	—	—	Action key to execute

Usage:

npx zapier-sdk get-action <app-key> <action-type> <action-key>

get-input-fields-schema

Get the JSON Schema representation of input fields for an action. Returns a JSON Schema object describing the structure, types, and validation rules for the action's input parameters.

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key (e.g., 'SlackCLIAPI' or slug like 'github') to get the input schema for
<action-type>	string	✅	—	read, read_bulk, write, run, search, search_or_write, search_and_write, filter	Action type that matches the action's defined type
<action-key>	string	✅	—	—	Action key to get the input schema for
--authentication-id	string	❌	—	—	Authentication ID to use when fetching the schema. Required if the action needs authentication to determine available fields.
--inputs	object	❌	—	—	Current input values that may affect the schema (e.g., when fields depend on other field values)

Usage:

npx zapier-sdk get-input-fields-schema <app-key> <action-type> <action-key> [--authentication-id] [--inputs]

list-actions

List all actions for a specific app

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key of actions to list (e.g., 'SlackCLIAPI' or slug like 'github')
--action-type	string	❌	—	read, read_bulk, write, run, search, search_or_write, search_and_write, filter	Filter actions by type
--page-size	number	❌	—	—	Number of actions per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk list-actions <app-key> [--action-type] [--page-size] [--max-items] [--cursor]

list-input-field-choices

Get the available choices for a dynamic dropdown input field

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key (e.g., 'SlackCLIAPI' or slug like 'github')
<action-type>	string	✅	—	read, read_bulk, write, run, search, search_or_write, search_and_write, filter	Action type that matches the action's defined type
<action-key>	string	✅	—	—	Action key to execute
<input-field-key>	string	✅	—	—	Input field key to get choices for.
--authentication-id	string	❌	—	—	Authentication ID to use for this action
--inputs	object	❌	—	—	Current input values that may affect available choices
--page	number	❌	—	—	Page number for paginated results
--page-size	number	❌	—	—	Number of choices per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk list-input-field-choices <app-key> <action-type> <action-key> <input-field-key> [--authentication-id] [--inputs] [--page] [--page-size] [--max-items] [--cursor]

list-input-fields

Get the input fields required for a specific action

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key (e.g., 'SlackCLIAPI' or slug like 'github')
<action-type>	string	✅	—	read, read_bulk, write, run, search, search_or_write, search_and_write, filter	Action type that matches the action's defined type
<action-key>	string	✅	—	—	Action key to execute
--authentication-id	string	❌	—	—	Authentication ID to use for this action
--inputs	object	❌	—	—	Current input values that may affect available fields
--page-size	number	❌	—	—	Number of input fields per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk list-input-fields <app-key> <action-type> <action-key> [--authentication-id] [--inputs] [--page-size] [--max-items] [--cursor]

run-action

Execute an action with the given inputs

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key (e.g., 'SlackCLIAPI' or slug like 'github')
<action-type>	string	✅	—	read, read_bulk, write, run, search, search_or_write, search_and_write, filter	Action type that matches the action's defined type
<action-key>	string	✅	—	—	Action key to execute
--authentication-id	string	❌	—	—	Authentication ID to use for this action
--inputs	object	❌	—	—	Input parameters for the action
--page-size	number	❌	—	—	Number of results per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk run-action <app-key> <action-type> <action-key> [--authentication-id] [--inputs] [--page-size] [--max-items] [--cursor]

Apps

get-app

Get detailed information about a specific app

Options:

Option	Type	Required	Default	Possible Values	Description
<app-key>	string	✅	—	—	App key of app to fetch (e.g., 'SlackCLIAPI' or slug like 'github')

Usage:

npx zapier-sdk get-app <app-key>

list-apps

List all available apps with optional filtering

Options:

Option	Type	Required	Default	Possible Values	Description
--app-keys	array	❌	—	—	Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github')
--search	string	❌	—	—	Search for apps by name
--page-size	number	❌	—	—	Number of apps per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk list-apps [--app-keys] [--search] [--page-size] [--max-items] [--cursor]

Authentications

find-first-authentication

Find the first authentication matching the criteria

Options:

Option	Type	Required	Default	Possible Values	Description
--app-key	string	❌	—	—	App key of authentication to find (e.g., 'SlackCLIAPI' or slug like 'github')
--search	string	❌	—	—	Search term to filter authentications by title
--title	string	❌	—	—	Filter authentications by exact title match
--account-id	string	❌	—	—	Filter by account ID
--owner	string	❌	—	—	Filter by owner

Usage:

npx zapier-sdk find-first-authentication [--app-key] [--search] [--title] [--account-id] [--owner]

find-unique-authentication

Find a unique authentication matching the criteria

Options:

Option	Type	Required	Default	Possible Values	Description
--app-key	string	❌	—	—	App key of authentication to find (e.g., 'SlackCLIAPI' or slug like 'github')
--search	string	❌	—	—	Search term to filter authentications by title
--title	string	❌	—	—	Filter authentications by exact title match
--account-id	string	❌	—	—	Filter by account ID
--owner	string	❌	—	—	Filter by owner

Usage:

npx zapier-sdk find-unique-authentication [--app-key] [--search] [--title] [--account-id] [--owner]

get-authentication

Get a specific authentication by ID

Options:

Option	Type	Required	Default	Possible Values	Description
<authentication-id>	number	✅	—	—	Authentication ID to retrieve

Usage:

npx zapier-sdk get-authentication <authentication-id>

list-authentications

List available authentications with optional filtering

Options:

Option	Type	Required	Default	Possible Values	Description
--app-key	string	❌	—	—	App key of authentications to list (e.g., 'SlackCLIAPI' or slug like 'github')
--authentication-ids	array	❌	—	—	List of authentication IDs to filter by
--search	string	❌	—	—	Search term to filter authentications by title
--title	string	❌	—	—	Filter authentications by exact title match
--account-id	string	❌	—	—	Filter by account ID
--owner	string	❌	—	—	Filter by owner, 'me' for your own authentications or a specific user ID
--page-size	number	❌	—	—	Number of authentications per page
--max-items	number	❌	—	—	Maximum total items to return across all pages
--cursor	string	❌	—	—	Cursor to start from

Usage:

npx zapier-sdk list-authentications [--app-key] [--authentication-ids] [--search] [--title] [--account-id] [--owner] [--page-size] [--max-items] [--cursor]

HTTP Requests

request

Make authenticated HTTP requests through Zapier's Relay service

Options:

Option	Type	Required	Default	Possible Values	Description
<url>	string	✅	—	—	The URL to request (will be proxied through Relay)
--method	string	❌	—	GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS	HTTP method
--body	string	❌	—	—	Request body as a string
--authentication-id	number	❌	—	—	Zapier authentication ID to use for the request
--callback-url	string	❌	—	—	URL to send async response to (makes request async)
--authentication-template	string	❌	—	—	Optional JSON string authentication template to bypass Notary lookup
--headers	string	❌	—	—	Request headers
--relay-base-url	string	❌	—	—	Base URL for Relay service

Usage:

npx zapier-sdk request <url> [--method] [--body] [--authentication-id] [--callback-url] [--authentication-template] [--headers] [--relay-base-url]

Utilities

add

Add apps with manifest locking and TypeScript type generation - updates .zapierrc with app versions and generates TypeScript definition files

Options:

Option	Type	Required	Default	Possible Values	Description
<app-keys>	array	✅	—	—	One or more app keys to add (e.g., 'slack', 'github', 'trello')
--authentication-ids	array	❌	—	—	Authentication IDs to use for type generation (e.g., ['123', '456'])
--config-path	string	❌	—	—	Path to Zapier config file (defaults to '.zapierrc', e.g., './custom/.zapierrc')
--types-output	string	❌	—	—	Directory for TypeScript type files (defaults to (src/lib/.)/zapier/apps/, e.g., './src/types/zapier/')

Usage:

npx zapier-sdk add <app-keys> [--authentication-ids] [--config-path] [--types-output]

build-manifest

Build manifest entries for apps - can optionally write to disk or just return JSON

Options:

Option	Type	Required	Default	Possible Values	Description
<app-keys>	array	✅	—	—	One or more app keys to build manifest entries for (e.g., 'slack', 'github', 'trello')
--skip-write	boolean	❌	—	—	If true, returns manifest entries without writing to disk. If false or omitted, writes to the manifest file.
--config-path	string	❌	—	—	Path to the manifest file. Only used when skipWrite is false or omitted.

Usage:

npx zapier-sdk build-manifest <app-keys> [--skip-write] [--config-path]

bundle-code

Bundle TypeScript code into executable JavaScript

Options:

Option	Type	Required	Default	Possible Values	Description
<input>	string	✅	—	—	Input TypeScript file path to bundle
--output	string	❌	—	—	Output file path (defaults to input with .js extension)
--string	boolean	❌	—	—	Return bundled code as string instead of writing to file
--minify	boolean	❌	—	—	Minify the bundled output
--target	string	❌	—	—	ECMAScript target version
--cjs	boolean	❌	—	—	Output CommonJS format instead of ESM

Usage:

npx zapier-sdk bundle-code <input> [--output] [--string] [--minify] [--target] [--cjs]

generate-app-types

Generate TypeScript type definitions for apps - can optionally write to disk or just return type strings

Options:

Option	Type	Required	Default	Possible Values	Description
<app-keys>	array	✅	—	—	One or more app keys to generate types for (e.g., 'slack', 'github', 'trello')
--authentication-ids	array	❌	—	—	Authentication IDs to use for type generation (e.g., ['123', '456'])
--skip-write	boolean	❌	—	—	If true, returns type definitions without writing to disk. If false or omitted, writes type files.
--types-output-directory	string	❌	—	—	Directory for TypeScript type files. Required when skipWrite is false or omitted.

Usage:

npx zapier-sdk generate-app-types <app-keys> [--authentication-ids] [--skip-write] [--types-output-directory]

get-login-config-path

Show the path to the login configuration file

Usage:

npx zapier-sdk get-login-config-path

mcp

Start MCP server for Zapier SDK

Options:

Option	Type	Required	Default	Possible Values	Description
--port	string	❌	—	—	Port to listen on (for future HTTP transport)

Usage:

npx zapier-sdk mcp [--port]