Documentation


This is a brief tutorial that describes how to create and launch an app on Ocean.

Setup Ocean CLI

First, create an access token on Ocean.

Then install the CLI

git clone git@github.com:ocean-oss/ocean-cli.git
cd ocean-cli
chmod -R 700 .

Configure the CLI:

export OCEAN_ACCESS_TOKEN=your_token
alias ocean="path_to_ocean/ocean-cli/ocean"

Create an App

mkdir my_first_app
cd my_first_app
ocean apps:create my_first_app true
git clone git@github.com:ocean-oss/base-app.git .

Update Your App

ocean apps:update my_first_app "Adding new changes"

Launch Your App

  1. Create and launch a workspace.
  2. Install and run my_first_app in your new workspace.
  3. Enjoy!