Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(cli) finish main oclif migration & remove unneeded code #133

Merged
merged 2 commits into from
Dec 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 0 additions & 62 deletions docs/cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,6 @@ <h2 class="docs-header__platform-title">Developer Platform</h2>
<li><a href="#envget">env:get</a></li>
<li><a href="#envset">env:set</a></li>
<li><a href="#envunset">env:unset</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="#integrations">integrations</a></li>
Expand Down Expand Up @@ -596,67 +595,6 @@ <h2 id="envunset">env:unset</h2>
</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 &amp; user)</li>
<li>./.zapierapprc (current directory identifies the app)</li>
</ul><p>The <code>zapier login</code> and <code>zapier register &quot;Example&quot;</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}</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"># &#x250C;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x252C;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x252C;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2510;</span>
<span class="hljs-comment"># &#x2502; Command &#x2502; Example &#x2502; Help &#x2502;</span>
<span class="hljs-comment"># &#x251C;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x253C;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x253C;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2524;</span>
<span class="hljs-comment"># &#x2502; apps &#x2502; zapier apps &#x2502; Lists all the apps you can access. &#x2502;</span>
<span class="hljs-comment"># &#x2502; build &#x2502; zapier build &#x2502; Builds a uploadable zip from the current directory. &#x2502;</span>
<span class="hljs-comment"># &#x2502; collaborate &#x2502; zapier collaborate [[email protected]] &#x2502; Manage the admins on your project. Can optionally --remove. &#x2502;</span>
<span class="hljs-comment"># &#x2502; push &#x2502; zapier push &#x2502; Build and upload the current app - does not promote. &#x2502;</span>
<span class="hljs-comment"># &#x2502; deprecate &#x2502; zapier deprecate 1.0.0 2017-01-20 &#x2502; Mark a non-production version of your app as deprecated by a certain date. &#x2502;</span>
<span class="hljs-comment"># &#x2502; describe &#x2502; zapier describe &#x2502; Describes the current app. &#x2502;</span>
<span class="hljs-comment"># &#x2502; env &#x2502; zapier env 1.0.0 CLIENT_SECRET 12345 &#x2502; Read and write environment variables. &#x2502;</span>
<span class="hljs-comment"># &#x2502; help &#x2502; zapier help [command] &#x2502; Lists all the commands you can use. &#x2502;</span>
<span class="hljs-comment"># &#x2502; history &#x2502; zapier history &#x2502; Prints all recent history for your app. &#x2502;</span>
<span class="hljs-comment"># &#x2502; init &#x2502; zapier init path &#x2502; Initializes a new zapier app in a directory. &#x2502;</span>
<span class="hljs-comment"># &#x2502; invite &#x2502; zapier invite [[email protected]] &#x2502; Manage the invitees/testers on your project. Can optionally --remove. &#x2502;</span>
<span class="hljs-comment"># &#x2502; link &#x2502; zapier link &#x2502; Link the current directory to an app you have access to. &#x2502;</span>
<span class="hljs-comment"># &#x2502; login &#x2502; zapier login &#x2502; Configure your `~/.zapierrc` with a deploy key. &#x2502;</span>
$ &#x2502; <span class="hljs-built_in">logout</span> &#x2502; zapier <span class="hljs-built_in">logout</span> &#x2502; Deactivates all your personal deploy keys and resets `~/.zapierrc`. &#x2502;
<span class="hljs-comment"># &#x2502; logs &#x2502; zapier logs &#x2502; Prints recent logs. See help for filter arguments. &#x2502;</span>
<span class="hljs-comment"># &#x2502; migrate &#x2502; zapier migrate 1.0.0 1.0.1 [10%] &#x2502; Migrate users from one version to another. &#x2502;</span>
<span class="hljs-comment"># &#x2502; promote &#x2502; zapier promote 1.0.0 &#x2502; Promotes a specific version to public access. &#x2502;</span>
<span class="hljs-comment"># &#x2502; register &#x2502; zapier register &quot;Example&quot; &#x2502; Registers a new app in your account. &#x2502;</span>
<span class="hljs-comment"># &#x2502; scaffold &#x2502; zapier scaffold resource &quot;Contact&quot; &#x2502; Adds a starting resource, trigger, action or search to your app. &#x2502;</span>
<span class="hljs-comment"># &#x2502; test &#x2502; zapier test &#x2502; Tests your app via `npm test`. &#x2502;</span>
<span class="hljs-comment"># &#x2502; upload &#x2502; zapier upload &#x2502; Upload the last build as a version. &#x2502;</span>
<span class="hljs-comment"># &#x2502; validate &#x2502; zapier validate &#x2502; Validates the current project. &#x2502;</span>
<span class="hljs-comment"># &#x2502; versions &#x2502; zapier versions &#x2502; Lists all the versions of the current app. &#x2502;</span>
<span class="hljs-comment"># &#x2514;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2534;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2534;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2500;&#x2518;</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>
Expand Down
60 changes: 0 additions & 60 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,66 +203,6 @@ Prints a human readable enumeration of your integrations's triggers, searches, a
* `zapier env:unset 1.2.3 SECRET OTHER`


## help

> Lists all the commands you can use.

**Usage:** `zapier help [command]`


Prints documentation to the terminal screen.

Generally - the `zapier` command works off of two files:

* ~/.zapierrc (home directory identifies the deploy key & user)
* ./.zapierapprc (current directory identifies the app)

The `zapier login` and `zapier register "Example"` or `zapier link` commands will help manage those files. All commands listed below.

**Arguments**

* _none_ -- print all commands
* `cmd [value]` -- _optional_, the command to view docs for
* `--format={plain,json,raw,row,table}` -- _optional_, display format. Default is `table`
* `--help` -- _optional_, prints this help text
* `--debug` -- _optional_, print debug API calls and tracebacks

```bash
$ zapier help apps
$ zapier help scaffold
$ zapier help
# Usage: zapier COMMAND [command-specific-arguments] [--command-specific-options]
#
# ┌─────────────┬───────────────────────────────────────┬────────────────────────────────────────────────────────────────────────────┐
# │ Command │ Example │ Help │
# ├─────────────┼───────────────────────────────────────┼────────────────────────────────────────────────────────────────────────────┤
# │ apps │ zapier apps │ Lists all the apps you can access. │
# │ build │ zapier build │ Builds a uploadable zip from the current directory. │
# │ collaborate │ zapier collaborate [[email protected]] │ Manage the admins on your project. Can optionally --remove. │
# │ push │ zapier push │ Build and upload the current app - does not promote. │
# │ deprecate │ zapier deprecate 1.0.0 2017-01-20 │ Mark a non-production version of your app as deprecated by a certain date. │
# │ describe │ zapier describe │ Describes the current app. │
# │ env │ zapier env 1.0.0 CLIENT_SECRET 12345 │ Read and write environment variables. │
# │ help │ zapier help [command] │ Lists all the commands you can use. │
# │ history │ zapier history │ Prints all recent history for your app. │
# │ init │ zapier init path │ Initializes a new zapier app in a directory. │
# │ invite │ zapier invite [[email protected]] │ Manage the invitees/testers on your project. Can optionally --remove. │
# │ link │ zapier link │ Link the current directory to an app you have access to. │
# │ login │ zapier login │ Configure your `~/.zapierrc` with a deploy key. │
$ │ logout │ zapier logout │ Deactivates all your personal deploy keys and resets `~/.zapierrc`. │
# │ logs │ zapier logs │ Prints recent logs. See help for filter arguments. │
# │ migrate │ zapier migrate 1.0.0 1.0.1 [10%] │ Migrate users from one version to another. │
# │ promote │ zapier promote 1.0.0 │ Promotes a specific version to public access. │
# │ register │ zapier register "Example" │ Registers a new app in your account. │
# │ scaffold │ zapier scaffold resource "Contact" │ Adds a starting resource, trigger, action or search to your app. │
# │ test │ zapier test │ Tests your app via `npm test`. │
# │ upload │ zapier upload │ Upload the last build as a version. │
# │ validate │ zapier validate │ Validates the current project. │
# │ versions │ zapier versions │ Lists all the versions of the current app. │
# └─────────────┴───────────────────────────────────────┴────────────────────────────────────────────────────────────────────────────┘
```


## history

> Gets the history of your integration.
Expand Down
Loading