zapier-platform-cli
Version:
The CLI for apps in the Zapier Developer Platform.
773 lines (720 loc) • 89.5 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-WNQKTM5');</script>
<!-- End Google Tag Manager -->
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Zapier Platform CLI Reference</title>
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.5.0/styles/agate.min.css">
<style>body {
font-family: 'Open Sans', Helvetica, arial, sans-serif;
background-color: #fff;
color: #5F6C72;
font-size: 14px;
font-weight: 400;
width: 100%;
height: 100%;
margin: 0;
padding: 0;
position: relative; }
img {
max-width: 100%; }
h1 {
color: #354147;
font-size: 28px;
font-weight: 400;
line-height: 1.3em;
padding: 20px 0; }
h2 {
color: #354147;
font-size: 20px;
line-height: 1.4em;
font-weight: 600;
padding: 1em 0; }
h3 {
color: #354147;
font-size: 15px;
line-height: 1.5em;
font-weight: 600;
padding: 0 0 0.5em 0; }
h4 {
color: #354147;
font-size: 0.9em;
letter-spacing: 1px;
line-height: 1.2em;
font-weight: 600;
padding: 0 0 10px;
text-transform: uppercase; }
a {
color: #499DF3;
text-decoration: none; }
a:hover {
text-decoration: underline; }
::-webkit-input-placeholder {
color: #969EA2; }
:-moz-placeholder {
color: #969EA2; }
::-moz-placeholder {
color: #969EA2; }
:-ms-input-placeholder {
color: #969EA2; }
p {
line-height: 1.6em;
margin: 0 0 15px; }
small {
font-size: 13px; }
i, em {
font-style: italic; }
strong {
font-weight: 600; }
sup, sub, .sup {
font-size: 13px;
vertical-align: baseline;
position: relative;
top: -0.4em; }
sup.small, sub.small, .sup.small {
font-size: 10px; }
sub {
top: 0.4em; }
pre {
border: none;
line-height: 20px;
font-family: 'Consolas','Liberation Mono',Courier,monospace; }
pre code {
display: block;
white-space: pre; /* no word wrap */
padding: 10px;
line-height: 1.7em; }
p code {
word-break: break-all;
display: inline; }
hr {
color: #DADFE2;
background: #DADFE2;
border: 0;
height: 1px; }
ul {
line-height: 1.75em;
margin: 0 0 20px; }
ol {
line-height: 1.75em;
list-style-type: decimal;
list-style-position: inside;
margin: 0 0 20px; }
blockquote {
border-left: 3px solid #ff4a00;
font-size: 14px;
font-style: italic;
line-height: 2em;
margin: 30px 0;
padding-left: 20px; }
blockquote p {
font-size: inherit;
font-style: inherit;
line-height: inherit; }
.docs-toc {
height: 100%;
width: 230px;
position: fixed;
padding: 40px 20px;
overflow-y: scroll;
overflow-x: hidden; }
.docs-toc ul {
margin: 0;
padding: 0 0 0 10px; }
.generated-by {
font-size: 12px;
color: #969EA2; }
.docs-main {}
.docs-code {
/* see media queries */ }
.docs-code pre {
background: #354147;
color: #ffffff;
line-height: 20px;
font-family: 'Consolas','Liberation Mono',Courier,monospace; }
.docs-code pre code {
display: block;
padding: 10px;
line-height: 1.7em; }
a code {
color: #499DF3;
background-color: #f2f4f9; }
/* targets bootstraps md width */
@media (min-width: 992px) {
.row-height {
display: table;
table-layout: fixed;
height: 100%;
width: 100%; }
.col-height {
display: table-cell;
float: none;
height: 100%; }
.docs-main {
margin-left: 230px; }
.docs-code {
background: #5F6C72;
color: #ffffff; }
}
@media (max-width: 992px) {
.docs-toc {
display: none; }
.is-empty {
display: none; }
}
</style>
</head>
<body>
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WNQKTM5"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->
<div class="docs-toc">
<ul>
<li><a href="#zapier-cli-reference">Zapier CLI Reference</a></li>
<li><a href="#commands">Commands</a><ul>
<li><a href="#apps">apps</a></li>
<li><a href="#build">build</a></li>
<li><a href="#collaborate">collaborate</a></li>
<li><a href="#convert">convert</a></li>
<li><a href="#delete">delete</a></li>
<li><a href="#deprecate">deprecate</a></li>
<li><a href="#describe">describe</a></li>
<li><a href="#env">env</a></li>
<li><a href="#help">help</a></li>
<li><a href="#history">history</a></li>
<li><a href="#init">init</a></li>
<li><a href="#invite">invite</a></li>
<li><a href="#link">link</a></li>
<li><a href="#login">login</a></li>
<li><a href="#logout">logout</a></li>
<li><a href="#logs">logs</a></li>
<li><a href="#migrate">migrate</a></li>
<li><a href="#promote">promote</a></li>
<li><a href="#push">push</a></li>
<li><a href="#register">register</a></li>
<li><a href="#scaffold">scaffold</a></li>
<li><a href="#test">test</a></li>
<li><a href="#upload">upload</a></li>
<li><a href="#validate">validate</a></li>
<li><a href="#versions">versions</a></li>
</ul>
</li>
</ul>
<hr />
<small><a class="generated-by" href="https://github.com/zapier/litdoc">generated by litdoc</a></small>
</div>
<div class="docs-main container-fluid">
<div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h1 id="zapier-cli-reference">Zapier CLI Reference</h1>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<p>These are the generated docs for all Zapier platform CLI commands.</p><p>You can install the CLI with <code>npm install -g zapier-platform-cli</code>.</p>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ npm install -g zapier-platform-cli
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h1 id="commands">Commands</h1>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="apps">apps</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Lists all the apps you can access.</p>
</blockquote><p> <strong>Usage:</strong> <code>zapier apps</code></p><p>Lists any apps that you have admin access to. Also checks the current directory for a linked app, which you can control with <code>zapier link</code>.</p><p><strong>Arguments</strong></p><ul>
<li><code>--format={plain,json,raw,row,table,small}</code> -- <em>optional</em>, display format. Default is <code>table</code></li>
<li><code>--help</code> -- <em>optional</em>, prints this help text</li>
<li><code>--debug</code> -- <em>optional</em>, print debug API calls and tracebacks</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ zapier apps
<span class="hljs-comment"># All apps listed below.</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># ┌─────────┬───────────-─┬─────────────────────┬────────┐</span>
<span class="hljs-comment"># │ Title │ Unique Slug │ Timestamp │ Linked │</span>
<span class="hljs-comment"># ├─────────┼───────────-─┼─────────────────────┼────────┤</span>
<span class="hljs-comment"># │ Example │ Example │ 2016-01-01T22:19:28 │ ✔ │</span>
<span class="hljs-comment"># └─────────┴───────────-─┴─────────────────────┴────────┘</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Try linking the current directory to a different app with the `zapier link` command.</span>
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="build">build</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Builds a pushable zip from the current directory.</p>
</blockquote><p> <strong>Usage:</strong> <code>zapier build</code></p><p>Builds a ready-to-upload zip file, but does not upload / push the zip file. Generally you'd use <code>zapier push</code> which does this and <code>zapier upload</code> together.</p><p>It does the following steps:</p><ul>
<li>Creates a temporary folder</li>
<li>Copies all code into the temporary folder</li>
<li>Adds an entry point <code>zapierwrapper.js</code></li>
<li>Generates and validates app definition.</li>
<li>Detects dependencies via browserify (optional)</li>
<li>Zips up all needed <code>.js</code> files</li>
<li>Moves the zip to <code>build/build.zip</code></li>
</ul><blockquote>
<p>If you get live errors like <code>Error: Cannot find module 'some-path'</code>, try disabling dependency detection.</p>
</blockquote><p><strong>Arguments</strong></p><ul>
<li><code>--disable-dependency-detection</code> -- <em>optional</em>, disables walking required files to slim the build</li>
<li><code>--include-js-map</code> -- <em>optional</em>, include .js.map files (usually source maps</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ zapier build
<span class="hljs-comment"># Building project.</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Copying project to temp directory - done!</span>
<span class="hljs-comment"># Installing project dependencies - done!</span>
<span class="hljs-comment"># Applying entry point file - done!</span>
<span class="hljs-comment"># Validating project - done!</span>
<span class="hljs-comment"># Building app definition.json - done!</span>
<span class="hljs-comment"># Zipping project and dependencies - done!</span>
<span class="hljs-comment"># Cleaning up temp directory - done!</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Build complete!</span>
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="collaborate">collaborate</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Manage the collaborators on your project. Can optionally --remove.</p>
</blockquote><p> <strong>Usage:</strong> <code>zapier collaborate [user@example.com]</code></p><p>Give any user registered on Zapier the ability to collaborate on your app. Commonly, this is useful for teammates, contractors, or other developers who might want to make changes on your app. Only admin access is supported. If you'd only like to provide read-only or testing access, try <code>zapier invite</code>.</p><p><strong>Arguments</strong></p><ul>
<li><em>none</em> -- print all collaborators</li>
<li><code>email [user@example.com]</code> -- <em>optional</em>, which user to add/remove</li>
<li><code>--remove</code> -- <em>optional</em>, elect to remove this user</li>
<li><code>--format={plain,json,raw,row,table,small}</code> -- <em>optional</em>, display format. Default is <code>table</code></li>
<li><code>--help</code> -- <em>optional</em>, prints this help text</li>
<li><code>--debug</code> -- <em>optional</em>, print debug API calls and tracebacks</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ zapier collaborate
<span class="hljs-comment"># The collaborators on your app "Example" listed below.</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># ┌──────────────────┬───────┬──────────┐</span>
<span class="hljs-comment"># │ Email │ Role │ Status │</span>
<span class="hljs-comment"># ├──────────────────┼───────┼──────────┤</span>
<span class="hljs-comment"># │ user@example.com │ admin │ accepted │</span>
<span class="hljs-comment"># └──────────────────┴───────┴──────────┘</span>
$ zapier collaborate user@example.com
<span class="hljs-comment"># Preparing to add collaborator user@example.com to your app "Example".</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Adding user@example.com - done!</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Collaborators updated! Try viewing them with `zapier collaborate`.</span>
$ zapier collaborate user@example.com --remove
<span class="hljs-comment"># Preparing to remove collaborator user@example.com from your app "Example".</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Removing user@example.com - done!</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Collaborators updated! Try viewing them with `zapier collaborate`.</span>
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="convert">convert</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Converts a Zapier Platform app to a CLI app, stubs only.</p>
</blockquote><p> <strong>Usage:</strong> <code>zapier convert appid path</code></p><p>Creates a new Zapier app from an existing app. <strong>The new app contains code stubs only.</strong> It is supposed to get you started - it isn't going to create a complete app!</p><p>After running this, you'll have a new app in your directory, with stubs for your trigger and actions. If you re-run this command on an existing directory it will leave existing files alone and not clobber them.</p><blockquote>
<p>Note: this doesn't register or push the app with Zapier - try <code>zapier register "Example"</code> and <code>zapier push</code> for that!</p>
</blockquote><p><strong>Arguments</strong></p><ul>
<li><code>appid [value]</code> -- <strong>required</strong>, Get the appid from <a href="https://zapier.com/developer/builder/">https://zapier.com/developer/builder/</a> (check the URL)</li>
<li><code>location [value]</code> -- <strong>required</strong>, Relative to your current path - IE: <code>.</code> for current directory</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ zapier convert 1234 .
<span class="hljs-comment"># Let's convert your app!</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Downloading app from Zapier - done!</span>
<span class="hljs-comment"># Writing triggers/trigger.js - done!</span>
<span class="hljs-comment"># Writing package.json - done!</span>
<span class="hljs-comment"># Writing index.js - done!</span>
<span class="hljs-comment"># Copy ./index.js - done!</span>
<span class="hljs-comment"># Copy ./package.json - done!</span>
<span class="hljs-comment"># Copy ./triggers/trigger.js - done!</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Finished! You might need to `npm install` then try `zapier test`!</span>
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="delete">delete</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Delete a version of your app (or the whole app) as long as it has no users/Zaps.</p>
</blockquote><p> <strong>Usage:</strong> <code>zapier delete version 1.0.0</code></p><p>A utility to allow deleting app versions that aren't used.</p><blockquote>
<p>The app version needs to have no users/Zaps in order to be deleted.</p>
</blockquote><p><strong>Arguments</strong></p><ul>
<li><code>appOrVersion [{app,version}]</code> -- <strong>required</strong>, delete the whole app, or just a version?</li>
<li><code>version [1.0.0]</code> -- <em>optional</em>, the version to delete</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ zapier delete version 1.0.0
<span class="hljs-comment"># Preparing to delete version 1.0.0 of your app "Example".</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Deleting 1.0.0 - done!</span>
<span class="hljs-comment"># Deletion successful!</span>
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="deprecate">deprecate</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Mark a non-production version of your app as deprecated, with removal by a certain date.</p>
</blockquote><p> <strong>Usage:</strong> <code>zapier deprecate 1.0.0 2017-01-20</code></p><p>A utility to alert users of breaking changes that require the deprecation of an app version.</p><p>Use this when an app version will not be supported or start breaking at a known date.</p><p>Zapier will send an email warning users of the deprecation once a date is set, they'll start seeing it as "Deprecated" in the UI, and once the deprecation date arrives, if the Zaps weren't updated, they'll be paused and the users will be emailed again explaining what happened.</p><p>After the deprecation date has passed it will be safe to delete that app version.</p><blockquote>
<p>Do not use this if you have non-breaking changes, for example, just fixing help text or labels is a very safe operation.</p>
</blockquote><p><strong>Arguments</strong></p><ul>
<li><code>version [1.0.0]</code> -- <strong>required</strong>, the version to deprecate</li>
<li><code>deprecationDate [2017-01-20]</code> -- <strong>required</strong>, date Zapier will make the version unavailable</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ zapier deprecate 1.0.0 2017-01-20
<span class="hljs-comment"># Preparing to deprecate version 1.0.0 your app "Example".</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Deprecating 1.0.0 - done!</span>
<span class="hljs-comment"># Deprecation successful!</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># We'll let users know that this version is no longer recommended and will cease to work on 2017-01-20.</span>
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="describe">describe</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Describes the current app.</p>
</blockquote><p> <strong>Usage:</strong> <code>zapier describe</code></p><p>Prints a human readable enumeration of your app's triggers, searches, and actions as seen by Zapier. Useful to understand how your resources convert and relate to different actions.</p><blockquote>
<p>These are the same actions we'd display in our editor!</p>
</blockquote><ul>
<li><code>Noun</code> -- your action's noun</li>
<li><code>Label</code> -- your action's label</li>
<li><code>Resource</code> -- the resource (if any) this action is tied to</li>
<li><code>Available Methods</code> -- testable methods for this action</li>
</ul><p><strong>Arguments</strong></p><ul>
<li><code>--format={plain,json,raw,row,table,small}</code> -- <em>optional</em>, display format. Default is <code>table</code></li>
<li><code>--help</code> -- <em>optional</em>, prints this help text</li>
<li><code>--debug</code> -- <em>optional</em>, print debug API calls and tracebacks</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ zapier describe
<span class="hljs-comment"># A description of your app "Example" listed below.</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Triggers</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># ┌────────────┬────────────────────┬──────────────┬───────────────────────────────────────────────┐</span>
<span class="hljs-comment"># │ Noun │ Label │ Resource Ref │ Available Methods │</span>
<span class="hljs-comment"># ├────────────┼────────────────────┼──────────────┼───────────────────────────────────────────────┤</span>
<span class="hljs-comment"># │ Member │ Updated Subscriber │ member │ triggers.updated_member.operation.perform │</span>
<span class="hljs-comment"># │ │ │ │ triggers.updated_member.operation.inputFields │</span>
<span class="hljs-comment"># │ │ │ │ resources.member.list.operation.perform │</span>
<span class="hljs-comment"># │ │ │ │ resources.member.list.operation.inputFields │</span>
<span class="hljs-comment"># └────────────┴────────────────────┴──────────────┴───────────────────────────────────────────────┘</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Searches</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Nothing found for searches, maybe try the `zapier scaffold` command?</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Creates</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Nothing found for creates, maybe try the `zapier scaffold` command?</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># If you'd like to add more, try the `zapier scaffold` command to kickstart!</span>
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="env">env</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Read and write environment variables.</p>
</blockquote><p> <strong>Usage:</strong> <code>zapier env 1.0.0 CLIENT_SECRET 12345</code></p><p>Manage the environment of your app so that <code>process.env</code> has the necessary variables, making it easy to match a local environment with a production environment via <code>CLIENT_SECRET=12345 zapier test</code>.</p><p><strong>Arguments</strong></p><ul>
<li><code>version [1.0.0]</code> -- <strong>required</strong>, the app version's environment to work on</li>
<li><code>key [CLIENT_SECRET]</code> -- <em>optional</em>, the uppercase key of the environment variable to set</li>
<li><code>value [12345]</code> -- <em>optional</em>, the raw value to set to the key</li>
<li><code>--remove</code> -- <em>optional</em>, optionally remove environment variable with this key</li>
<li><code>--format={plain,json,raw,row,table,small}</code> -- <em>optional</em>, display format. Default is <code>table</code></li>
<li><code>--help</code> -- <em>optional</em>, prints this help text</li>
<li><code>--debug</code> -- <em>optional</em>, print debug API calls and tracebacks</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ zapier env 1.0.0
<span class="hljs-comment"># The env of your "Example" listed below.</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># ┌─────────┬───────────────┬───────┐</span>
<span class="hljs-comment"># │ Version │ Key │ Value │</span>
<span class="hljs-comment"># ├─────────┼───────────────┼───────┤</span>
<span class="hljs-comment"># │ 1.0.0 │ CLIENT_SECRET │ 12345 │</span>
<span class="hljs-comment"># └─────────┴───────────────┴───────┘</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Try setting an env with the `zapier env 1.0.0 CLIENT_SECRET 12345` command.</span>
$ zapier env 1.0.0 CLIENT_SECRET 12345
<span class="hljs-comment"># Preparing to set environment CLIENT_SECRET for your 1.0.0 "Example".</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Setting CLIENT_SECRET to "12345" - done!</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Environment updated! Try viewing it with `zapier env 1.0.0`.</span>
$ zapier env 1.0.0 CLIENT_SECRET --remove
<span class="hljs-comment"># Preparing to remove environment CLIENT_SECRET for your 1.0.0 "Example".</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Deleting CLIENT_SECRET - done!</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Environment updated! Try viewing it with `zapier env 1.0.0`.</span>
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="help">help</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Lists all the commands you can use.</p>
</blockquote><p> <strong>Usage:</strong> <code>zapier help [command]</code></p><p>Prints documentation to the terminal screen.</p><p>Generally - the <code>zapier</code> command works off of two files:</p><ul>
<li>~/.zapierrc (home directory identifies the deploy key & user)</li>
<li>./.zapierapprc (current directory identifies the app)</li>
</ul><p>The <code>zapier login</code> and <code>zapier register "Example"</code> or <code>zapier link</code> commands will help manage those files. All commands listed below.</p><p><strong>Arguments</strong></p><ul>
<li><em>none</em> -- print all commands</li>
<li><code>cmd [value]</code> -- <em>optional</em>, the command to view docs for</li>
<li><code>--format={plain,json,raw,row,table,small}</code> -- <em>optional</em>, display format. Default is <code>table</code></li>
<li><code>--help</code> -- <em>optional</em>, prints this help text</li>
<li><code>--debug</code> -- <em>optional</em>, print debug API calls and tracebacks</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ zapier <span class="hljs-built_in">help</span> apps
$ zapier <span class="hljs-built_in">help</span> scaffold
$ zapier <span class="hljs-built_in">help</span>
<span class="hljs-comment"># Usage: zapier COMMAND [command-specific-arguments] [--command-specific-options]</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># ┌─────────────┬───────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────┐</span>
<span class="hljs-comment"># │ Command │ Example │ Help │</span>
<span class="hljs-comment"># ├─────────────┼───────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────┤</span>
<span class="hljs-comment"># │ apps │ zapier apps │ Lists all the apps you can access. │</span>
<span class="hljs-comment"># │ build │ zapier build │ Builds a uploadable zip from the current directory. │</span>
<span class="hljs-comment"># │ collaborate │ zapier collaborate [user@example.com] │ Manage the collaborators on your project. Can optionally --remove. │</span>
<span class="hljs-comment"># │ push │ zapier push │ Build and upload the current app - does not promote. │</span>
<span class="hljs-comment"># │ deprecate │ zapier deprecate 1.0.0 2017-01-20 │ Mark a non-production version of your app as deprecated by a certain date. │</span>
<span class="hljs-comment"># │ describe │ zapier describe │ Describes the current app. │</span>
<span class="hljs-comment"># │ env │ zapier env 1.0.0 CLIENT_SECRET 12345 │ Read and write environment variables. │</span>
<span class="hljs-comment"># │ help │ zapier help [command] │ Lists all the commands you can use. │</span>
<span class="hljs-comment"># │ history │ zapier history │ Prints all recent history for your app. │</span>
<span class="hljs-comment"># │ init │ zapier init path │ Initializes a new zapier app in a directory. │</span>
<span class="hljs-comment"># │ invite │ zapier invite [user@example.com] │ Manage the invitees/testers on your project. Can optionally --remove. │</span>
<span class="hljs-comment"># │ link │ zapier link │ Link the current directory to an app you have access to. │</span>
<span class="hljs-comment"># │ login │ zapier login │ Configure your `~/.zapierrc` with a deploy key. │</span>
$ │ <span class="hljs-built_in">logout</span> │ zapier <span class="hljs-built_in">logout</span> │ Deactivates all your personal deploy keys and resets `~/.zapierrc`. │
<span class="hljs-comment"># │ logs │ zapier logs │ Prints recent logs. See help for filter arguments. │</span>
<span class="hljs-comment"># │ migrate │ zapier migrate 1.0.0 1.0.1 [10%] │ Migrate users from one version to another. │</span>
<span class="hljs-comment"># │ promote │ zapier promote 1.0.0 │ Promotes a specific version to public access. │</span>
<span class="hljs-comment"># │ register │ zapier register "Example" │ Registers a new app in your account. │</span>
<span class="hljs-comment"># │ scaffold │ zapier scaffold resource "Contact" │ Adds a starting resource, trigger, action or search to your app. │</span>
<span class="hljs-comment"># │ test │ zapier test │ Tests your app via `npm test`. │</span>
<span class="hljs-comment"># │ upload │ zapier upload │ Upload the last build as a version. │</span>
<span class="hljs-comment"># │ validate │ zapier validate │ Validates the current project. │</span>
<span class="hljs-comment"># │ versions │ zapier versions │ Lists all the versions of the current app. │</span>
<span class="hljs-comment"># └─────────────┴───────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────┘</span>
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="history">history</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Prints all edit history for your app.</p>
</blockquote><p> <strong>Usage:</strong> <code>zapier history</code></p><p>Get the history of your app, listing all the changes made over the lifetime of your app. This includes everything from creation, updates, migrations, collaborator and invitee changes as well as who made the change and when.</p><p><strong>Arguments</strong></p><ul>
<li><code>--format={plain,json,raw,row,table,small}</code> -- <em>optional</em>, display format. Default is <code>table</code></li>
<li><code>--help</code> -- <em>optional</em>, prints this help text</li>
<li><code>--debug</code> -- <em>optional</em>, print debug API calls and tracebacks</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ zapier <span class="hljs-built_in">history</span>
<span class="hljs-comment"># The history of your app "Example" listed below.</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># ┌──────────────────────────┬───────────────────┬──────────────────┬─────────────────────┐</span>
<span class="hljs-comment"># │ What │ Message │ Who │ Timestamp │</span>
<span class="hljs-comment"># ├──────────────────────────┼───────────────────┼──────────────────┼─────────────────────┤</span>
<span class="hljs-comment"># │ collaborator added │ other@example.com │ user@example.com │ 2016-01-10T16:12:33 │</span>
<span class="hljs-comment"># │ environment variable set │ CLIENT_SECRET │ user@example.com │ 2016-01-01T22:51:01 │</span>
<span class="hljs-comment"># │ version added │ 1.2.52 │ user@example.com │ 2016-01-01T22:19:36 │</span>
<span class="hljs-comment"># │ app created │ initial creation │ user@example.com │ 2016-01-01T22:19:28 │</span>
<span class="hljs-comment"># └──────────────────────────┴───────────────────┴──────────────────┴─────────────────────┘</span>
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="init">init</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Initializes a new Zapier app in a directory.</p>
</blockquote><p> <strong>Usage:</strong> <code>zapier init path</code></p><p>Initializes a new Zapier app. If you specify a template, will download and install the app from that template.</p><p>After running this, you'll have a new example app in your directory. If you re-run this command on an existing directory it will leave existing files alone and not clobber them.</p><blockquote>
<p>Note: this doesn't register or deploy the app with Zapier - try <code>zapier register "Example"</code> and <code>zapier push</code> for that!</p>
</blockquote><p><strong>Arguments</strong></p><ul>
<li><code>path [value]</code> -- <strong>required</strong>,</li>
<li><code>--template={minimal,resource,trigger,create,search,middleware,basic-auth,custom-auth,oauth2,session-auth,babel,rest-hooks,files}</code> -- <em>optional</em>, select a starting app template. Default is <code>minimal</code></li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ zapier init example-app --template=minimal
<span class="hljs-comment"># Let's initialize your app!</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Downloading zapier/zapier-platform-example-app-minimal starter app - done!</span>
<span class="hljs-comment"># Copy /users/username/code/example-app/.gitignore - done!</span>
<span class="hljs-comment"># Copy /users/username/code/example-app/index.js - done!</span>
<span class="hljs-comment"># Copy /users/username/code/example-app/package.json - done!</span>
<span class="hljs-comment"># Copy /users/username/code/example-app/test/index.js - done!</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># Finished! You might need to `npm install` then try `zapier test`!</span>
</code></pre>
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<h2 id="invite">invite</h2>
</div>
<div class="col-md-7 col-sm-12 col-height is-empty docs-code">
</div>
</div>
</div><div class="row">
<div class="row-height">
<div class="col-md-5 col-sm-12 col-height docs-primary">
<blockquote>
<p>Manage the invitees/testers on your project. Can optionally --remove.</p>
</blockquote><p> <strong>Usage:</strong> <code>zapier invite [user@example.com]</code></p><p>Invite any user registered on Zapier to test your app. Commonly, this is useful for teammates, contractors, or other team members who might want to test, QA, or view your apps. If you'd like to provide full admin access, try <code>zapier collaborate</code>.</p><blockquote>
<p>Send an email directly, which contains a one-time use link for them only - or share the public URL to "bulk" invite folks!</p>
</blockquote><p><strong>Arguments</strong></p><ul>
<li><em>none</em> -- print all invitees</li>
<li><code>email [user@example.com]</code> -- <em>optional</em>, which user to add/remove</li>
<li><code>--remove</code> -- <em>optional</em>, elect to remove this user</li>
<li><code>--format={plain,json,raw,row,table,small}</code> -- <em>optional</em>, display format. Default is <code>table</code></li>
<li><code>--help</code> -- <em>optional</em>, prints this help text</li>
<li><code>--debug</code> -- <em>optional</em>, print debug API calls and tracebacks</li>
</ul>
</div>
<div class="col-md-7 col-sm-12 col-height docs-code">
<pre><code class="lang-bash">$ zapier invite
<span class="hljs-comment"># The invitees on your app listed below.</span>
<span class="hljs-comment">#</span>
<span class="hljs-comme