Quick Start Guide
Step-by-step quick start guide to setting up Qualityfolio, authoring Markdown-based test artifacts, generating evidence-backed SQLite databases, and launching test management dashboards.
This Quick Start Guide walks you through the core Qualityfolio workflow, from organizing your project structure and authoring Markdown-based test artifacts to generating evidence-backed SQLite databases and launching live test management dashboards. It demonstrates how Qualityfolio delivers Operational Truth using Test-Management-as-Code (TMaC), powered by Spry’s Axiom-based execution and Surveilr’s ingestion and transformation pipeline.
System Requirements
- Runtime: Deno 2.x or later (required)
- Package Manager: Homebrew (required)
- Tools: Spry, Surveilr (required)
Dependencies
Ensure the following tools and files are available on your system before proceeding:
- Deno – runtime required by Spry
- Homebrew (brew) – package manager for installing dependencies
- Spry – runbook and SQLPage orchestration engine
- Surveilr – ingestion and transformation engine
- Qualityfolio Extension – Visual Studio Code Extension/ Cursor IDE Extension which simplifies editing Evidence Block values
Installation Commands
To work with Spry and the Surveilr-based Qualityfolio framework, you need to download and install Deno, Homebrew, Spry, and Surveilr, and ensure the required Qualityfolio files are available in your workspace.
Run these commands in sequence to set up all dependencies in one go:
# 1. Install Deno
curl -fsSL https://deno.com/install.sh | sh
# 2. Install Homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
# 3. Install Spry
brew install programmablemd/packages/spry
# 4. Install Surveilr
wget https://github.com/surveilr/packages/releases/download/3.23.0/surveilr_3.23.0_x86_64-unknown-linux-gnu.tar.gz
tar -xzf surveilr_3.23.0_x86_64-unknown-linux-gnu.tar.gz
sudo mv surveilr /usr/local/bin/
# Verify Installations
deno --version && brew --version && spry --version && surveilr --versionRun these commands in sequence to set up all dependencies in one go:
# 1. Install Deno
curl -fsSL https://deno.com/install.sh | sh
# 2. Install Homebrew
curl -fsSL -o install.sh https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh
# 3. Install Spry
brew install programmablemd/packages/spry
# 4. Install Surveilr
brew tap surveilr/tap && brew install surveilr
# Verify Installations
deno --version && brew --version && spry --version && surveilr --versionInstall Qualityfolio Extension (for Visual Studio Code/ Cursor IDE)
To install Qualityfolio extension, download and install the pre-packaged extension for Visual Studio Code or Cursor IDE from the links below:
Authoring Tests in Markdown
Qualityfolio tests follow a structured Markdown hierarchy to ensure full traceability and machine-readable execution. Qualityfolio projects can range from simple to highly complex structures. You can explore ready-made examples based on real-world implementations.
An example test artifact file (example-artifact.md) for the project OWASP - GLUE UP (using Qualityfolio's Small pattern) is available here.
Example Demonstrates
Key Concepts:
- Header-based Classification - Structured metadata for test organization
- Hierarchical Test Design - Nested test suites and cases
- Evidence Block Patterns - Linking test results with execution evidence
Project Structure
Working with Qualityfolio
Generate Test Management Dashboard
The Test Management Dashboard provides a live, browser-based view of Qualityfolio metrics.
Next Steps
Once your database and dashboard are running, you can:
- Query
resource-surveillance.sqlite.dbfor custom analytics - Extend SQLPage views by updating
qualityfolio.md - Add new test artifacts and execution evidence
- Integrate Qualityfolio into CI/CD pipelines
How is this guide?
Last updated on
Download Operational Truth™ - Quality Assurance Module
Operational Truth™ is a downloadable software platform for continuous compliance. The Quality Assurance module (powered by Qualityfolio) must be installed on a local workstation or server environment. The software is not web-based and requires local installation to operate. To install Qualityfolio, users must first set up the required software dependencies and then download and install the primary Qualityfolio application package by following the provided installation instructions.
Architecture Overview
Next Page