npm package: @seashell/cli
Description: CLI for managing Seashell apps and devices from the command line.
Author: eschmidt
Latest version: 1.0.0-rc1

Seashell CLI
============

<img src="https://avatars0.githubusercontent.com/u/39317436?s=200&v=4" data-canonical-src="https://avatars0.githubusercontent.com/u/39317436?s=200&v=4" width="100px" height="100px" styles="width:100px;height:100px"/>

The Seashell CLI is used to manage Seashell apps and devices from the command line.

It is built using the amazing [oclif](https://oclif.io) framework made available by Heroku.

To learn more about Seashell see <https://seashell.sh>

Overview
========

This is the first version of Seashell's CLI. It is uses Node under-the-hood, and has Docker as its only dependency.

Issues
======

For problems directly related to the CLI, [add an issue on GitHub](https://github.com/seashell/cli/issues/new).


<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage
<!-- usage -->
```sh-session
$ npm install -g @seashell/cli
$ seashell COMMAND
running command...
$ seashell (-v|--version|version)
@seashell/cli/0.0.4-rc4 linux-x64 node-v10.9.0
$ seashell --help [COMMAND]
USAGE
  $ seashell COMMAND
...
```
<!-- usagestop -->

# Commands
<!-- commands -->
* [`seashell build`](#seashell-build)
* [`seashell help [COMMAND]`](#seashell-help-command)
* [`seashell init NAME`](#seashell-init-name)
* [`seashell login`](#seashell-login)
* [`seashell release TAG`](#seashell-release-tag)
* [`seashell services:add NAME [URL]`](#seashell-servicesadd-name-url)
* [`seashell services:build NAME VERSION`](#seashell-servicesbuild-name-version)
* [`seashell services:delete NAME`](#seashell-servicesdelete-name)
* [`seashell services:release NAME IMAGE`](#seashell-servicesrelease-name-image)

## `seashell build`

Build and app for release

```
USAGE
  $ seashell build

DESCRIPTION
  ...
  Extra documentation goes here
```

_See code: [src/commands/build.js](https://github.com/seashell/cli/blob/v0.0.4-rc4/src/commands/build.js)_

## `seashell help [COMMAND]`

display help for seashell

```
USAGE
  $ seashell help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6/src/commands/help.ts)_

## `seashell init NAME`

Initialize a Seashell application within the current directory

```
USAGE
  $ seashell init NAME

ARGUMENTS
  NAME  Application name, as defined within Seashell Cloud.

DESCRIPTION
  ...
  The current directory is assumed to be a valid Git repository
```

_See code: [src/commands/init.js](https://github.com/seashell/cli/blob/v0.0.4-rc4/src/commands/init.js)_

## `seashell login`

Login to Seashell Cloud

```
USAGE
  $ seashell login

DESCRIPTION
  ...
  Extra documentation goes here
```

_See code: [src/commands/login.js](https://github.com/seashell/cli/blob/v0.0.4-rc4/src/commands/login.js)_

## `seashell release TAG`

Submit an App release

```
USAGE
  $ seashell release TAG

ARGUMENTS
  TAG  Release tag.

DESCRIPTION
  ...
           The current directory correponds to an initialzied Seashell App
```

_See code: [src/commands/release.js](https://github.com/seashell/cli/blob/v0.0.4-rc4/src/commands/release.js)_

## `seashell services:add NAME [URL]`

Add a service to a Seashell App

```
USAGE
  $ seashell services:add NAME [URL]

ARGUMENTS
  NAME  Service name.
  URL   Service's repository url

DESCRIPTION
  ...
  Extra documentation goes here
```

_See code: [src/commands/services/add.js](https://github.com/seashell/cli/blob/v0.0.4-rc4/src/commands/services/add.js)_

## `seashell services:build NAME VERSION`

Add a service to a Seashell App

```
USAGE
  $ seashell services:build NAME VERSION

ARGUMENTS
  NAME     Service name.
  VERSION  Build version.

DESCRIPTION
  ...
  Extra documentation goes here
```

_See code: [src/commands/services/build.js](https://github.com/seashell/cli/blob/v0.0.4-rc4/src/commands/services/build.js)_

## `seashell services:delete NAME`

Delete a service from a Seashell App

```
USAGE
  $ seashell services:delete NAME

ARGUMENTS
  NAME  Service name.

OPTIONS
  -y, --assume-yes  Automatic yes to prompt

DESCRIPTION
  ...
  Extra documentation goes here
```

_See code: [src/commands/services/delete.js](https://github.com/seashell/cli/blob/v0.0.4-rc4/src/commands/services/delete.js)_

## `seashell services:release NAME IMAGE`

Release a Seashell App service

```
USAGE
  $ seashell services:release NAME IMAGE

ARGUMENTS
  NAME   Service name.
  IMAGE  Service image.

DESCRIPTION
  ...
  Extra documentation goes here
```

_See code: [src/commands/services/release.js](https://github.com/seashell/cli/blob/v0.0.4-rc4/src/commands/services/release.js)_
<!-- commandsstop -->