Installation

Spry can be installed via multiple methods depending on your platform and preferences. Choose the method that works best for your workflow.

Homebrew (Recommended for macOS & Linux)

The easiest way to install Spry on macOS or Linux is via Homebrew:

# Install via Homebrew
brew install programmablemd/packages/spry

Or add the tap first, then install:

brew tap programmablemd/homebrew-packages
brew install spry

Homebrew automatically manages updates and dependencies, making it the recommended installation method for most users.

Install Specific Version

To install a specific version of Spry:

Option 1: Using version suffix

brew install programmablemd/packages/spry@0.102.1

Option 2: Switch between installed versions

If you have multiple versions installed:

brew unlink spry@0.102.1 && brew link spry@0.101.3

Direct Binary Download

Download pre-built binaries from the GitHub Releases page:

Platform	Format
macOS (Intel & Apple Silicon)	`.tar.gz`
Ubuntu 22.04 / Debian 12	`.deb`
Windows x64	`.zip`

For Debian-based systems:

# Download and install the .deb package
sudo dpkg -i spry_<version>_amd64.deb

# 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

For macOS (manual installation):

# Extract the archive
tar -xzf spry_<version>_darwin_amd64.tar.gz

# Move to your PATH
sudo mv spry /usr/local/bin/

# Example
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

For Windows:

Extract the .zip file
Add the extracted directory to your system PATH
Restart your terminal

Manual binary installations won't receive automatic updates. You'll need to download new versions manually.

Verify Installation

Check Version

Confirm Spry is installed correctly by checking the version:

spry --version

You should see output like:

Spry v0.101.x

View Available Commands

Display the help menu to see all available commands:

spry --help

This shows the main command groups:

axiom - Document structure exploration
rb (runbook) - Task execution
sp (sqlpage) - SQLPage application management

Test Execution

Create a simple test file to verify execution works:

echo '```bash test
echo "Hello from Spry!"
```' > test.md

spry rb run test.md

You should see:

Hello from Spry!

System Requirements

Minimum Requirements

Operating System: macOS 10.15+, Ubuntu 20.04+, Windows 10+, or equivalent Linux distribution
RAM: 512 MB minimum, 2 GB recommended
Disk Space: 50 MB for Spry binary, plus space for your projects

Optional Dependencies

Some features require additional tools:

Tool	Purpose	Installation
SQLPage	Run SQLPage web applications	sqlpage.com
direnv	Automatic environment variable loading	`brew install direnv` or direnv.net
Git	Version control integration	Pre-installed on most systems

SQLPage for Web Applications

If you plan to build SQLPage applications, install SQLPage separately:

# macOS/Linux with Homebrew
brew install sqlpage

# Or download from https://github.com/lovasoa/SQLpage/releases

Environment Setup

Using direnv (Recommended)

Spry works well with direnv for automatic environment variable management:

Install direnv

# macOS
brew install direnv

# Ubuntu/Debian
sudo apt-get install direnv

Configure Your Shell

Add to your shell configuration:

# For bash (~/.bashrc)
eval "$(direnv hook bash)"

# For zsh (~/.zshrc)
eval "$(direnv hook zsh)"

Create .envrc File

Spry can generate .envrc files automatically:

```envrc prepare-env -C ./.envrc --gitignore --descr "Generate .envrc file and add it to local .gitignore if it's not already there"
export SPRY_DB="sqlite://app.db?mode=rwc"
export PORT=9227


Then allow direnv to load it:
```bash
direnv allow

Manual Environment Setup

If you prefer not to use direnv, you can source environment files manually:

# Create environment file
cat > .envrc << 'EOF'
export SPRY_DB="sqlite://app.db?mode=rwc"
export PORT=9227
EOF

# Load environment
source .envrc

Updating Spry

# Update Homebrew
brew update

# Upgrade Spry
brew upgrade spry

Download the latest release from GitHub and replace your existing installation following the same installation steps.

How is this guide?

Installation

On this page