Installation

Installation can be done in two ways.

By using the Execution Package
By using Deno.

Installation of Executable Package

Package Managers (Recommended)

Homebrew (macOS & Linux)

Option 1: Install directly (without tapping)

brew install programmablemd/packages/spry-sqlpage
brew install programmablemd/packages/spry-runbook

Option 2: Install from this tap

# Add the tap
brew tap programmablemd/homebrew-packages

# Install spry-runbook and spry-runbook
brew install spry-sqlpage spry-runbook

# Install spry-sqlpage
brew install spry-sqlpage

# Install spry-runbook
brew install spry-runbook

Ubuntu/Debian (.deb packages)

# Ubuntu 22.04 (Jammy)
wget https://github.com/programmablemd/packages/releases/download/v0.80.0/spry-sqlpage_0.80.0-ubuntu22.04u1_amd64.deb
sudo dpkg -i spry-sqlpage_0.80.0-ubuntu22.04u1_amd64.deb

# Debian 12 (Bookworm)
wget https://github.com/programmablemd/packages/releases/download/v0.80.0/spry-sqlpage_0.80.0-debian12u1_amd64.deb
sudo dpkg -i spry-sqlpage_0.80.0-debian12u1_amd64.deb

macOS (Manual Installation)

If you prefer not to use Homebrew:

# Download and extract
wget https://github.com/programmablemd/packages/releases/download/v0.80.0/spry-sqlpage-macos.tar.gz
tar -xzf spry-sqlpage-macos.tar.gz
sudo mv spry-sqlpage-macos /usr/local/bin/spry-sqlpage

Windows

# Download the Windows packages
# https://github.com/programmablemd/packages/releases/download/v0.80.0/spry-sqlpage-windows.zip
# https://github.com/programmablemd/packages/releases/download/v0.80.0/spry-runbook-windows.zip

# Extract the zip files and run:
.\spry-sqlpage.exe --help
.\spry-runbook.exe --help

Direct Download

Visit GitHub Releases page to download pre-built binaries for your operating system:

Windows: spry-sqlpage-windows.zip, spry-runbook-windows.zip
macOS: spry-sqlpage-macos.tar.gz, spry-runbook-macos.tar.gz
Linux DEB: spry-sqlpage_jammy.deb, spry-sqlpage_bookworm.deb

Verification

After installation, verify that spry-sqlpage and spry-runbook are working correctly:

spry-sqlpage --version
spry-sqlpage --help

spry-runbook --version
spry-runbook --help

Installation By using Deno.

Prerequisites:

Before installing Spry, make sure you have the following installed on your system:

Deno: Spry runs on the Deno runtime (v1.30 or later)
Database: SQLite or PostgreSQL
SQLPage (optional): For building web applications

Installing Deno

Spry is built on Deno, a modern JavaScript/TypeScript runtime. Install it using the following command:

curl -fsSL https://deno.land/install.sh | sh

irm https://deno.land/install.ps1 | iex

Verify Installation

After installation, verify Deno is installed correctly by running: deno --version

Installing Spry

Initialize a new Spry project using the installation script. Choose your preferred database:

SQLite Setup

Create a new Spry project with SQLite (default):

curl -fsSL https://sprymd.org/init.sh | sh -s

This creates a new Spry project in the current directory with SQLite configuration.

SQLite is perfect for development and small to medium applications. No separate database server required!

PostgreSQL Setup

Create a new Spry project with PostgreSQL:

curl -fsSL https://sprymd.org/init.sh | sh -s -- --dialect postgres

Custom Directory

Specify a custom target directory:

curl -fsSL https://sprymd.org/init.sh | sh -s -- --target-dir myproject --dialect postgres

PostgreSQL is recommended for production deployments and applications requiring advanced database features.

Project Structure

After initialization, your project will have the following structure:

myproject/
├── Spryfile.md          # Main executable markdown file
├── spry.ts              # Spry CLI
├── sqlpage/
│   ├── sqlpage.json     # SQLPage configuration
│   └── migrations/      # Database migrations
└── dev-src.auto/        # Auto-generated SQLPage source files

Verify Installation

Test your Spry installation:

./spry.ts --version

You should see the Spry version number printed to the console.

Next Steps

Now that Spry is installed, head over to the Quick Start guide to build your first application!

How is this guide?

Installation

On this page