Welcome to Spawn

Spawn makes it easier to include the database as an automated component in your DevOps pipeline.

The Spawn service does this by creating ("Spawning") databases that more accurately represent what's in production, and in a way that reduces the burden of infrastructure and data management.

This guide explains how Spawn works, and how to control it via the command-line.

Getting started

If you're new to Spawn, we'd recommend following the steps below.

  1. Download and install Spawn
  2. Learn about the Spawn concepts and commands

Download and install Spawn

Spawn is currently accepting applications for the private beta programme.
Apply for the beta programme. If you're accepted onto the programme you'll be able to download Spawn and follow the instruction below in order to install it.

Install Spawn

Windows
  1. Download spawnctl
  2. Add the folder containing spawnctl to the path
Mac and Linux
  1. Run this
curl -sL https://run.spawn.cc/install | sh
  1. Add spawnctl to your path
export PATH=$PATH:$HOME/.spawnctl/bin
  1. Verify the CLI is installed by running
spawnctl version
  1. Authenticate to the Spawn service
spawnctl auth
  1. Onboard to the Spawn service
spawnctl onboard

Using Spawn

The next section introduces the concepts of Spawn, and the terminology it uses. We recommend getting familiar with the concepts of Spawn before working through the examples in the Commands section.

Introduction →