Getting Started

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 cloud deploy.

Prerequisites

The Sp00ky CLI installed (npm i -g @sp00ky/cli)
A sp00ky.yml config file in your project root
Docker installed locally (for building backend images)

Quick Start

Bash

# 1. Log in to Sp00ky Cloud
spky cloud login

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

# 3. Deploy
spky cloud deploy

Authentication

Bash

spky cloud 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:

Bash

spky cloud logout

CI/CD

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

Creating a Project

Bash

# Interactive — prompts for slug if not provided
spky cloud create

# With options
spky cloud create --slug my-app --plan starter

Available plans: starter, pro, business. The slug must be lowercase alphanumeric with hyphens, and is globally unique.

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

yaml

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

Listing Projects

Bash

spky cloud list

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

Destroying a Project

Warning

This permanently tears down all VMs and infrastructure for the project. Data will be lost unless you have a backup.

Bash

spky cloud destroy

Billing

Bash

# Open the billing portal
spky cloud billing

# View current month's usage
spky cloud billing usage