Skip to content
StatelyDB

Getting Started

Create a Stately Cloud Account

Before you can do anything else you need a Stately Cloud account. Your account is used for things like accessing the control panel and CLI.

  1. Visit https://console.stately.cloud and log in with your preferred account.
  2. You should now be logged in to the console, with a new, empty organization for yourself.
  3. Email us at [email protected] and we can create a Store and a Schema for you to use. We’ll also create an API key to allow you to access the store from code.

Download the stately CLI

Download our CLI for your platform of choice by visiting https://stately.cloud/downloads. The CLI is required for working with schema and generating client SDKs. Windows users are recommended to use WSL. For operating systems with a Unix-y shell, you can run this command to install:

curl -sL https://stately.cloud/install | sh

Once the CLI has been installed, log in using the same account you used on the console:

stately login

Install an SDK

Install the SDK for your language. We currently support Go, TypeScript/JavaScript, Python and Ruby. If your favorite language isn’t one of those, let us know at [email protected].

go get github.com/StatelyCloud/go-sdk