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. Click “Create Store” to get a new store and schema to use. Write down both the Store ID and Schema ID.

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

go get github.com/StatelyCloud/go-sdk

Ruby

bundle add statelydb

Python

pip install statelydb

TypeScript

npm install @stately-cloud/client