Installation

Get started with Spin in just a few minutes

Prerequisites

tmux (Required for process management)
Git (for version control)
Docker (for service management)

Quick Install

Install Spin:

Verify installation:

spin

Platform-Specific Setup

macOS

Install prerequisites using Homebrew:

# Install tmux
brew install tmux

# Install Docker Desktop for macOS
brew install --cask docker

Linux

Install prerequisites using apt (Ubuntu/Debian):

# Install tmux
sudo apt update && sudo apt install tmux

# Install Docker Engine
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
sudo usermod -aG docker $USER

Or using yum (RHEL/CentOS):

# Install tmux
sudo yum install tmux

# Install Docker Engine
sudo yum install -y yum-utils
sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
sudo yum install docker-ce docker-ce-cli containerd.io
sudo systemctl start docker
sudo usermod -aG docker $USER

Quick Start Guide

Creating a New Project

Get started with a new project in minutes:

# Create a new directory
mkdir myapp
cd myapp

# Initialize Spin
spin init .

# Start your development environment
spin up

Using with Existing Projects

Add Spin to an existing project:

# Navigate to your project
cd existing-project

# Initialize Spin (creates spin.config.json)
spin init . --force

# Configure your services in spin.config.json
# Start development
spin up

Next Steps

Create a new project directory
Initialize with spin init
Configure your development environment
Start developing with spin up

→ Learn about Spin commands → Configure Spin for your project → Understand the development workflow