Seashell CLI

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

It is built using the amazing oclif 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.

• Usage
• Commands

Usage

$ 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
...

Commands

• seashell build
• seashell help [COMMAND]
• seashell init NAME
• seashell login
• seashell release TAG
• seashell services:add NAME [URL]
• seashell services:build NAME VERSION
• seashell services:delete NAME
• seashell services:release NAME IMAGE

seashell build

Build and app for release

USAGE
  $ seashell build

DESCRIPTION
  ...
  Extra documentation goes here

See code: 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

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

seashell login

Login to Seashell Cloud

USAGE
  $ seashell login

DESCRIPTION
  ...
  Extra documentation goes here

See code: 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

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

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

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

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