zapier-platform-cli：使用您已经知道JavaScript工具构建Zapier集成并在本地进行测试

<!-- GENERATED! ONLY EDIT `README-source.md` --> # MOVED This code has been moved to: https://github.com/zapier/zapier-platform/tree/master/packages/cli --- <h1 align="center"> <a href="https://zapier.com"><img src="https://cdn.rawgit.com/zapier/zapier-platform-cli/master/goodies/zapier-logomark.png" alt="Zapier" width="200"></a> <br> Zapier Platform CLI <br> <br> </h1> <p align="center"> <a href="https://travis-ci.org/zapier/zapier-platform-cli"><img src="https://img.shields.io/travis/zapier/zapier-platform-cli/master.svg" alt="Travis"></a> <a href="https://www.npmjs.com/package/zapier-platform-cli"><img src="https://img.shields.io/npm/v/zapier-platform-cli.svg" alt="npm version"></a> <!--possible downloads badge too, once that's good--> </p> Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform. [These docs are available here](http://zapier.github.io/zapier-platform-cli/), the [CLI docs are available here](http://zapier.github.io/zapier-platform-cli/cli.html), and you can [view all the schema definitions here](https://zapier.github.io/zapier-platform-schema/build/schema.html). ## Table of Contents <!-- toc --> - [Getting Started](#getting-started) * [What is an App?](#what-is-an-app) * [How does Zapier Platform CLI Work?](#how-does-zapier-platform-cli-work) * [Zapier Platform CLI vs UI](#zapier-platform-cli-vs-ui) * [Requirements](#requirements) * [Quick Setup Guide](#quick-setup-guide) * [Tutorial](#tutorial) - [Creating a Local App](#creating-a-local-app) * [Local Project Structure](#local-project-structure) * [Local App Definition](#local-app-definition) - [Registering an App](#registering-an-app) - [Deploying an App Version](#deploying-an-app-version) * [Private App Version (default)](#private-app-version-default) * [Sharing an App Version](#sharing-an-app-version) * [Promoting an App Version](#promoting-an-app-version) - [Converting an Existing App](#converting-an-existing-app) - [Authentication](#authentication) * [Basic](#basic) * [Digest](#digest) * [Custom](#custom) * [Session](#session) * [OAuth1](#oauth1) * [OAuth2](#oauth2) - [Resources](#resources) * [Resource Definition](#resource-definition) - [Triggers/Searches/Creates](#triggerssearchescreates) * [Return Types](#return-types) - [Input Fields](#input-fields) * [Custom/Dynamic Fields](#customdynamic-fields) * [Dynamic Dropdowns](#dynamic-dropdowns) * [Search-Powered Fields](#search-powered-fields) * [Computed Fields](#computed-fields) * [Nested & Children (Line Item) Fields](#nested--children-line-item-fields) - [Output Fields](#output-fields) * [Nested & Children (Line Item) Fields](#nested--children-line-item-fields-1) - [Z Object](#z-object) * [`z.request([url], options)`](#zrequesturl-options) * [`z.console`](#zconsole) * [`z.dehydrate(func, inputData)`](#zdehydratefunc-inputdata) * [`z.dehydrateFile(func, inputData)`](#zdehydratefilefunc-inputdata) * [`z.stashFile(bufferStringStream, [knownLength], [filename], [contentType])`](#zstashfilebufferstringstream-knownlength-filename-contenttype) * [`z.JSON`](#zjson) * [`z.hash()`](#zhash) * [`z.errors`](#zerrors) * [`z.cursor`](#zcursor) - [Bundle Object](#bundle-object) * [`bundle.authData`](#bundleauthdata) * [`bundle.inputData`](#bundleinputdata) * [`bundle.inputDataRaw`](#bundleinputdataraw) * [`bundle.meta`](#bundlemeta) * [`bundle.rawRequest`](#bundlerawrequest) * [`bundle.cleanedRequest`](#bundlecleanedrequest) * [`bundle.targetUrl`](#bundletargeturl) * [`bundle.subscribeData`](#bundlesubscribedata) - [Environment](#environment) * [Defining Environment Variables](#defining-environment-variables) * [Accessing Environment Variables](#accessing-environment-variables) - [Making HTTP Requests](#making-http-requests) * [Shorthand HTTP Requests](#shorthand-http-requests) * [Manual HTTP Requests](#manual-http-requests) + [POST and PUT Requests](#post-and-put-requests) * [Using HTTP middleware](#using-http-middleware) * [HTTP Request Options](#http-request-options) * [HTTP Response Object](#http-response-object) - [Dehydration](#dehydration) * [File Dehydration](#file-dehydration) - [Stashing Files](#stashing-files) - [Logging](#logging) * [Console Logging](#console-logging) * [Viewing Console Logs](#viewing-console-logs) * [Viewing Bundle Logs](#viewing-bundle-logs) * [HTTP Logging](#http-logging) * [Viewing HTTP Logs](#viewing-http-logs) - [Error Handling](#error-handling) * [General Errors](#general-errors) * [Halting Execution](#halting-execution) * [Stale Authentication Credentials](#stale-authentication-credentials) - [Testing](#testing) * [Writing Unit Tests](#writing-unit-tests) * [Mocking Requests](#mocking-requests) * [Running Unit Tests](#running-unit-tests) * [Testing & Environment Variables](#testing--environment-variables) * [Viewing HTTP Logs in Unit Tests](#viewing-http-logs-in-unit-tests) * [Testing in Your CI](#testing-in-your-ci) - [Using `npm` Modules](#using-npm-modules) - [Building Native Packages with Docker](#building-native-packages-with-docker) - [Using Transpilers](#using-transpilers) - [Example Apps](#example-apps) - [FAQs](#faqs) * [Why doesn't Zapier support newer versions of Node.js?](#why-doesnt-zapier-support-newer-versions-of-nodejs) * [How do I manually set the Node.js version to run my app with?](#how-do-i-manually-set-the-nodejs-version-to-run-my-app-with) * [When to use placeholders or curlies?](#when-to-use-placeholders-or-curlies) * [Does Zapier support XML (SOAP) APIs?](#does-zapier-support-xml-soap-apis) * [Is it possible to iterate over pages in a polling trigger?](#is-it-possible-to-iterate-over-pages-in-a-polling-trigger) * [How do search-powered fields relate to dynamic dropdowns and why are they both required together?](#how-do-search-powered-fields-relate-to-dynamic-dropdowns-and-why-are-they-both-required-together) * [What's the deal with pagination? When is it used and how does it work?](#whats-the-deal-with-pagination-when-is-it-used-and-how-does-it-work) * [How does deduplication work?](#how-does-deduplication-work) * [Why are my triggers complaining if I don't provide an explicit `id` field?](#why-are-my-triggers-complaining-if-i-dont-provide-an-explicit-id-field) - [Command Line Tab Completion](#command-line-tab-completion) * [Zsh Completion Script](#zsh-completion-script) * [Bash Completion Script](#bash-completion-script) - [The Zapier Platform Packages](#the-zapier-platform-packages) * [Updating](#updating) - [Development of the CLI](#development-of-the-cli) * [Commands](#commands) * [Publishing of the CLI (after merging)](#publishing-of-the-cli-after-merging) - [Get Help!](#get-help) <!-- tocstop --> ## Getting Started > If you're new to Zapier Platform CLI, we strongly recommend you to walk through the [Tutorial](https://zapier.com/developer/start) for a more thorough introduction. ### What is an App? A CLI App is an implementation of your app's API. You build a Node.js application that exports a single object ([JSON Schema](https://zapier.github.io/zapier-platform-schema/build/schema.html#appschema)) and upload it to Zapier. Zapier introspects that definition to find out what your app is capable of and what options to present end users in the Zap Editor. For those not familiar with Zapier terminology, here is how concepts in the CLI map to the end user experience: * [Authentication](#authentication), (usually) which lets us know what credentials to ask users for. This is used during the "Connect Accounts" section of the Zap Editor. * [Triggers](#triggerssearchescreates), which read data *from* your API. These have their own section in the Zap Editor. * [Creates](#triggerssearchescreates), which send data *to* your API to create new records. These are listed under "Actions" in the Zap Editor. *