Skip to main content

Welcome to Spawn

Spawn makes it easy to automate disposable copies of databases for your DevOps pipelines and your development environment. It uses a command line interface to create and manage those copies, and to make scripting and automation simple.

Getting started#

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

  1. Download and install Spawn
  2. Create a data container

Download and install Spawn#

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

On-board to Spawn#

  1. Verify the CLI is installed by running
spawnctl version
  1. Authenticate to the Spawn service
spawnctl auth
  1. Onboard to the Spawn service to create your account
spawnctl onboard

Create a data container#

Spawn creates data containers (copies of databases) from data images. Usually you'll create data containers from your own images, but to get you started there are some public data images available.

Create a copy of the PostgreSQL Pagila demo database by running

spawnctl create data-container --image pagila:v11 --lifetime 1h

The service returns the connection details for the database. Use any database client to connect to the database as usual.

Next steps#

Learn about the concepts of Spawn and the terminology it uses, or work through the examples in the Commands section.