Getting started with Cloud

Sp00ky Cloud handles infrastructure provisioning, scaling, and management so you can deploy your project with a single command. No Docker Compose files, no server setup, just spky deploy.

Prerequisites

The Sp00ky CLI installed (pnpm add -D @spooky-sync/cli per project, or npm i -g @spooky-sync/cli globally)
A sp00ky.yml config file in your project root
Docker installed locally (for building backend images)

Quick Start

The console walks you through this for a repository of yours, with the commands written for it and each one ticking off as it runs. Or, from a terminal:

# 1. Log in to Sp00ky Cloud
spky login

# 2. Create a cloud project
spky project create --slug my-app

# 3. Deploy
spky deploy

Once it is up, spky status lists your endpoints. One of them is https://<slug>-admin.<domain>/admin, the operator dashboard: cluster health, live logs, workflow runs and the restart and backup actions, in a browser. Grant yourself access with spky admin add <user> before you go looking, since the roster starts empty.

Authentication

spky login

A 4-digit verification code is shown in your terminal. Confirm it in the browser to authenticate. Credentials are saved to ~/.sp00ky/credentials.json.

To log out:

spky logout

CI/CD

For automated pipelines, create an API key with spky token create and set the SPOOKY_API_KEY environment variable. See CI/CD for details.

Creating a Project

# Interactive, prompts for slug if not provided
spky project create

# With options
spky project create --slug my-app --plan payg

Available plans: payg (the default) runs the project on Cloudflare and bills a monthly base fee that includes some usage, the rest by use; pro runs it on VMs. starter takes no new projects for now. Every plan starts with a checkout (pay as you go bills monthly only), and a project cannot move between Cloudflare and VM hosting later: create a new project instead. The free plan is retired. What each plan includes, and the spend cap of a pay-as-you-go project, are on Plans & billing. The slug must be lowercase alphanumeric with hyphens, and is globally unique.

Your project slug should match the slug field in your sp00ky.yml:

# sp00ky.yml
slug: my-app
# ... rest of config

Listing Projects

spky project list

Shows all your cloud projects with their plan, status, and creation date.

Destroying a Project

Warning

Destroying a project deletes everything it has, for good: its containers or Workers, its database and the volumes behind it, and its backups too. Nothing is kept to restore from. To keep the data, export it first with surreal export, using the login spky project credentials prints.

spky project destroy

Once the project is gone, its subscription is cancelled and its slug is free again. A new project created with that slug starts with an empty database: nothing of the old project carries over.

Billing

# Open the billing portal
spky billing

# View current month's usage
spky billing usage