Skip to content
Docs

Installation

Prerequisites

Section titled “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

Section titled “Installing Deno”

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

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

Installing Spry

Section titled “Installing Spry”

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

SQLite Setup

Section titled “SQLite Setup”

Create a new Spry project with SQLite (default):

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

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

Project Structure

Section titled “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

Section titled “Verify Installation”

Test your Spry installation:

Terminal window
./spry.ts --version

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