npm - deploy.sh - Versions diffs - 1.0.0 → 3.0.0 - Mend

deploy.sh 1.0.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (161) hide show

package/.claude/settings.local.json +36 -0
package/.github/ISSUE_TEMPLATE/bug_report.yml +105 -0
package/.github/ISSUE_TEMPLATE/config.yml +5 -0
package/.github/ISSUE_TEMPLATE/feature_request.yml +56 -0
package/.github/workflows/ci.yml +29 -0
package/.github/workflows/pages.yml +48 -0
package/.oxfmtrc.json +7 -0
package/.oxlintrc.json +11 -0
package/LICENSE +183 -183
package/README.md +99 -11
package/app/actions/deployments.ts +82 -0
package/app/actions/metrics.ts +13 -0
package/app/root.tsx +60 -0
package/app/routes/dashboard/detail/history.tsx +73 -0
package/app/routes/dashboard/detail/layout.tsx +125 -0
package/app/routes/dashboard/detail/logs.tsx +85 -0
package/app/routes/dashboard/detail/overview.tsx +119 -0
package/app/routes/dashboard/detail/requests.tsx +163 -0
package/app/routes/dashboard/detail/resources.tsx +268 -0
package/app/routes/dashboard/detail/shared.tsx +59 -0
package/app/routes/dashboard/index.tsx +360 -0
package/app/routes/dashboard/layout.tsx +30 -0
package/app/routes/docs/architecture.tsx +155 -0
package/app/routes/docs/cli.tsx +122 -0
package/app/routes/docs/deploying.tsx +105 -0
package/app/routes/docs/index.tsx +104 -0
package/app/routes/docs/layout.tsx +58 -0
package/app/routes/home.tsx +134 -0
package/app/routes/root.client.tsx +46 -0
package/app/routes.ts +21 -0
package/app/styles.css +15 -0
package/app/theme.css +134 -0
package/bin/deploy.js +360 -110
package/docs-site/404.html +33 -0
package/docs-site/home.tsx +130 -0
package/docs-site/index.html +35 -0
package/docs-site/layout.tsx +57 -0
package/docs-site/main.tsx +41 -0
package/docs-site/shell.tsx +34 -0
package/docs-site/styles.css +4 -0
package/drizzle.config.js +8 -0
package/examples/docker/Dockerfile +5 -0
package/examples/docker/server.js +18 -0
package/examples/node/package.json +7 -0
package/examples/node/pnpm-lock.yaml +9 -0
package/examples/node/server.js +12 -0
package/examples/static/index.html +48 -0
package/package.json +41 -55
package/public/favicon.ico +0 -0
package/react-router-vite/entry.browser.tsx +49 -0
package/react-router-vite/entry.rsc.single.tsx +7 -0
package/react-router-vite/entry.rsc.tsx +36 -0
package/react-router-vite/entry.ssr.tsx +29 -0
package/react-router-vite/plugin.ts +114 -0
package/react-router-vite/types.d.ts +11 -0
package/react-router.config.ts +5 -0
package/server/api.test.ts +344 -0
package/server/api.ts +445 -0
package/server/docker.ts +268 -0
package/server/index.ts +17 -0
package/server/metrics-collector.ts +29 -0
package/server/schema.ts +56 -0
package/server/store.test.ts +278 -0
package/server/store.ts +398 -0
package/tsconfig.json +21 -0
package/vite.config.ts +45 -0
package/vite.docs.config.ts +31 -0
package/.eslintignore +0 -5
package/.eslintrc +0 -23
package/.travis.yml +0 -9
package/.tryitout +0 -48
package/CHANGELOG.md +0 -56
package/bin/deploy-delete.js +0 -11
package/bin/deploy-deploy.js +0 -31
package/bin/deploy-list.js +0 -32
package/bin/deploy-login.js +0 -39
package/bin/deploy-logout.js +0 -12
package/bin/deploy-logs.js +0 -19
package/bin/deploy-open.js +0 -19
package/bin/deploy-register.js +0 -40
package/bin/deploy-server.js +0 -5
package/bin/deploy-whoami.js +0 -12
package/docs/code/CLI.html +0 -2901
package/docs/code/Deployment.html +0 -2469
package/docs/code/Request.html +0 -906
package/docs/code/User.html +0 -1219
package/docs/code/classifier.js.html +0 -121
package/docs/code/deploy.js.html +0 -122
package/docs/code/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Bold-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-Bold-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-Italic-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Italic-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-Italic-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-Light-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Light-webfont.svg +0 -1831
package/docs/code/fonts/OpenSans-Light-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
package/docs/code/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-Regular-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Regular-webfont.svg +0 -1831
package/docs/code/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-Semibold-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-Semibold-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-Semibold-webfont.ttf +0 -0
package/docs/code/fonts/OpenSans-Semibold-webfont.woff +0 -0
package/docs/code/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
package/docs/code/fonts/OpenSans-SemiboldItalic-webfont.svg +0 -1830
package/docs/code/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
package/docs/code/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
package/docs/code/helpers_cli.js.html +0 -315
package/docs/code/helpers_util.js.html +0 -194
package/docs/code/index.html +0 -66
package/docs/code/models_deployment.js.html +0 -515
package/docs/code/models_request.js.html +0 -158
package/docs/code/models_user.js.html +0 -198
package/docs/code/module-lib_classifier.html +0 -246
package/docs/code/module-lib_deploy.html +0 -350
package/docs/code/module-lib_helpers_util.html +0 -707
package/docs/code/scripts/linenumber.js +0 -25
package/docs/code/scripts/prettify/Apache-License-2.0.txt +0 -202
package/docs/code/scripts/prettify/lang-css.js +0 -2
package/docs/code/scripts/prettify/prettify.js +0 -28
package/docs/code/styles/jsdoc-default.css +0 -692
package/docs/code/styles/prettify-jsdoc.css +0 -111
package/docs/code/styles/prettify-tomorrow.css +0 -132
package/docs/example.gif +0 -0
package/docs/example.mov +0 -0
package/docs/index.html +0 -4463
package/docs/logo.png +0 -0
package/docs/logo.pxm +0 -0
package/docs/logo@2x.png +0 -0
package/docs/main.css +0 -162
package/docs/main.js +0 -53
package/index.js +0 -55
package/jsdoc.json +0 -27
package/lib/classifier.js +0 -61
package/lib/deploy.js +0 -62
package/lib/helpers/cli.js +0 -255
package/lib/helpers/util.js +0 -134
package/lib/models/deployment.js +0 -455
package/lib/models/request.js +0 -98
package/lib/models/user.js +0 -138
package/lib/server.js +0 -165
package/lib/static/not-found.html +0 -30
package/lib/static/page-could-not-load.html +0 -30
package/lib/static/static-server.js +0 -69
package/test/fixtures/docker/Dockerfile +0 -5
package/test/fixtures/docker/index.js +0 -12
package/test/fixtures/node/index.js +0 -8
package/test/fixtures/node/package.json +0 -15
package/test/fixtures/static/index.html +0 -14
package/test/fixtures/static/main.css +0 -7
package/test/fixtures/static/out.gifcd +0 -0
package/test/fixtures/unknown/.gitkeep +0 -0
package/test/lib/classifier.js +0 -51
package/test/lib/helpers/util.js +0 -47

package/docs/code/CLI.html DELETED Viewed

@@ -1,2901 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width,initial-scale=1">
-    <title>CLI - Documentation</title>
-    <script src="scripts/prettify/prettify.js"></script>
-    <script src="scripts/prettify/lang-css.js"></script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-<body>
-<input type="checkbox" id="nav-trigger" class="nav-trigger" />
-<label for="nav-trigger" class="navicon-button x">
-  <div class="navicon"></div>
-</label>
-<label for="nav-trigger" class="overlay"></label>
-<nav>
-    <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="CLI.html">CLI</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.cacheCredentials">cacheCredentials</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.createBundle">createBundle</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.deleteDeployment">deleteDeployment</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.getCredentials">getCredentials</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.getDeployments">getDeployments</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.getLogs">getLogs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.getUserDetails">getUserDetails</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.login">login</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.logout">logout</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.register">register</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.removeBundle">removeBundle</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CLI.html#.uploadBundle">uploadBundle</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Deployment.html">Deployment</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.decorate">decorate</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.del">del</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.get">get</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.getAll">getAll</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.logs">logs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.proxy">proxy</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.remove">remove</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.start">start</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.stop">stop</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Deployment.html#.update">update</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Request.html">Request</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Request.html#.count">count</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Request.html#.del">del</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Request.html#.log">log</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="User.html">User</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="User.html#.authenticate">authenticate</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="User.html#.authenticateMiddleware">authenticateMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="User.html#.login">login</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="User.html#.logout">logout</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="User.html#.register">register</a></span></li><li class="nav-heading">Modules</li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-lib_classifier.html">lib/classifier</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-lib_deploy.html">lib/deploy</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-lib_helpers_util.html">lib/helpers/util</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_util.html#.mk">mk</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_util.html#~contains">contains</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_util.html#~getPort">getPort</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-lib_helpers_util.html#~hash">hash</a></span></li>
-</nav>
-<div id="main">
-    <h1 class="page-title">CLI</h1>
-<section>
-<header>
-        <h2>
-        CLI
-        </h2>
-</header>
-<article>
-    <div class="container-overview">
-<div class="section-method">
-    <h4 class="name" id="CLI"><span class="type-signature"></span>new CLI<span class="signature">(options)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>the cli instance that holds all options and methods to talk to the deploy.sh service</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line14">line 14</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-                <p>contains defaults and overrides</p>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>url</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the url of the remote deploy.sh service</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>application</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the deployed application name to alter</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>mongo</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the mongo connection string used by deploy.sh service when running <code>deploy serve --mongo ''</code></p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-    </tbody>
-</table>
-</div>
-    </div>
-        <h3 class="subsection-title">Methods</h3>
-<div class="section-method">
-    <h4 class="name" id=".cacheCredentials"><span class="type-signature">(static) </span>cacheCredentials<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>persists the token and username locally</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line204">line 204</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>token to make authenticated calls</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>username linked to the token</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".createBundle"><span class="type-signature">(static) </span>createBundle<span class="signature">(directory)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>creates a bundle to send to the server for deployment</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line27">line 27</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>directory</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the directory that is to be turned into a tar</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".deleteDeployment"><span class="type-signature">(static) </span>deleteDeployment<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>deletes the specified deployment</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line168">line 168</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>token to make authenticated calls</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>username linked to the token</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>name</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>name of the deployment</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".getCredentials"><span class="type-signature">(static) </span>getCredentials<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>gets the token and username that were persisted locally</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line227">line 227</a>
-    </li></ul></dd>
-</dl>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".getDeployments"><span class="type-signature">(static) </span>getDeployments<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>gets the user's deployed applications</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line146">line 146</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-                <td class="attributes">
-                </td>
-            <td class="description last">
-                <p>token to make authenticated calls</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-                <td class="attributes">
-                </td>
-            <td class="description last">
-                <p>username linked to the token</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>name</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-            <td class="description last">
-                <p>name of the deployment</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".getLogs"><span class="type-signature">(static) </span>getLogs<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>gets the application logs</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line127">line 127</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>token to make authenticated calls</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>username linked to the token</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>name</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>name of the deployment</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".getUserDetails"><span class="type-signature">(static) </span>getUserDetails<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>gets the user details</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line187">line 187</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options.token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>token to make authenticated calls</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>options.username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>username linked to the token</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".login"><span class="type-signature">(static) </span>login<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>calls the login api to get a token to persist for future requests</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line73">line 73</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>username of the account</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>password</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>password associated with the account</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".logout"><span class="type-signature">(static) </span>logout<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>calls the logout api to invalidate token</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line109">line 109</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>token</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>token to make authenticated calls</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>username linked to the token</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".register"><span class="type-signature">(static) </span>register<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>prompts the user to register account</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line91">line 91</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>username</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>username of the account</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>password</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>password associated with the account</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".removeBundle"><span class="type-signature">(static) </span>removeBundle<span class="signature">(directory)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>removes the bundle from the given directory</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line41">line 41</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>directory</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>path to directory</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id=".uploadBundle"><span class="type-signature">(static) </span>uploadBundle<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
-<div class="description">
-    <p>Deals with uploading a specified bundle</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="helpers_cli.js.html">helpers/cli.js</a>, <a href="helpers_cli.js.html#line51">line 51</a>
-    </li></ul></dd>
-</dl>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>Object</code></span>
-            </td>
-            <td class="description last">
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>name</code></td>
-            <td class="type">
-<span class="param-type"><code>String</code></span>
-            </td>
-            <td class="description last">
-                <p>the name of the specified application</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>bundle</code></td>
-            <td class="type">
-<span class="param-type"><code>Stream</code></span>
-            </td>
-            <td class="description last">
-                <p>a file stream of the tar</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>Promise</code></span>
-    </dd>
-</dl>
-</div>
-</div>
-</article>
-</section>
-</div>
-<br class="clear">
-<footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
-</footer>
-<script>prettyPrint();</script>
-<script src="scripts/linenumber.js"></script>
-</body>
-</html>