Spry LogoOpsfolio
Getting Started

Install Spry Operational Truth™

Spry is a downloadable software package that must be installed on a local workstation or server environment. The software is not web-based and requires local installation to operate.To install Spry, users must first set up the required software dependencies and then download and install the primary Spry application package by following the provided installation instructions.

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

Latest Version Installation

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.

Latest Binary Download

Download the latest version using these stable links for Ubuntu 22.04 (Jammy) :

wget https://github.com/programmablemd/packages/releases/download/latest/spry-ubuntu22.04u1_amd64.deb
sudo dpkg -i spry-ubuntu22.04u1_amd64.deb

Install Latest Binary Download for Debian 12 (Bookworm)

wget https://github.com/programmablemd/packages/releases/download/latest/spry-debian12u1_amd64.deb
sudo dpkg -i spry-debian12u1_amd64.deb

macOS Binary Download

Download pre-built binaries from the GitHub Releases page.

Installation Steps:

wget https://github.com/programmablemd/packages/releases/download/latest/spry-macos.tar.gz
tar -xzf spry-macos.tar.gz
sudo cp spry-macos /usr/local/bin/spry
chmod +x /usr/local/bin/spry

Binaries support both Intel and Apple Silicon Macs.

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

Download and InstallLatest Stable Version for Windows

  1. Download the spry-windows.zip.
  2. Extract the .zip file to a location of your choice
  3. Add the extracted directory to your system PATH:
    • Open System Properties → Advanced → Environment Variables
    • Edit the Path variable and add the directory containing spry.exe
  4. Restart your terminal or command prompt

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

Verify Installation

    spry --version
    spry --help

Versioned Packages (v1.0.3) Installation

You can find all released versions on the GitHub Releases page. Select the version you wish to install (for example, v1.0.3) before continuing.

To install a specific version of Spry: Option 1: Using version suffix

    brew install spry@1.0.3
wget https://github.com/programmablemd/packages/releases/download/v1.0.3/spry_1.0.3-ubuntu22.04u1_amd64.deb
sudo dpkg -i spry_1.0.3-ubuntu22.04u1_amd64.deb
wget https://github.com/programmablemd/packages/releases/download/v1.0.3/spry_1.0.3-debian12u1_amd64.deb
sudo dpkg -i spry_1.0.3-debian12u1_amd64.deb

macOS Binary Download

Download pre-built binaries from the GitHub Releases page.

    # Download and extract the archive
    wget https://github.com/programmablemd/packages/releases/download/v1.0.3/spry-macos.tar.gz
    tar -xzf spry-sqlpage-macos.tar.gz
    
    # Move to your PATH
    sudo mv spry-sqlpage-macos /usr/local/bin/spry-sqlpage

Binaries support both Intel and Apple Silicon Macs.

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

  1. Download the .zip file for your desired version (v1.0.3) from the GitHub Releases page
  2. Extract the .zip file to a location of your choice
  3. Add the extracted directory to your system PATH:
    • Open System Properties → Advanced → Environment Variables
    • Edit the Path variable and add the directory containing spry.exe
  4. Restart your terminal or command prompt

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 vx.x.x
#Example:
Spry v1.0.3

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:

ToolPurposeInstallation
SQLPageRun SQLPage web applicationssqlpage.com
direnvAutomatic environment variable loadingbrew install direnv or direnv.net
GitVersion control integrationPre-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

Updating Spry

# Update Homebrew
brew update

# Upgrade Spry
brew upgrade spry

Example: Installing and using Spry version 1.0.2 when spry@1.0.3 is already installed

brew install spry@1.0.2
brew link --overwrite spry@1.0.2 
brew unlink spry@1.0.3 && brew link spry@1.0.2

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

How is this guide?

Last updated on

On this page