Read and Interpret Zof Reports

Understand Zof reports, findings, and recommendations at a glance.

Prerequisites

Before you begin, make sure you have:

• A Zof account - Sign up free
• Access to your code repository (GitHub, GitLab, or Bitbucket)
• Node.js 18+ or Python 3.9+

What you'll achieve

• Installed and authenticated the Zof CLI
• Connected Zof to your project
• Ran your first reliability test
• Viewed results in the Zof dashboard

Step 1: Install the Zof CLI

Open your terminal and install the CLI globally:

npm install -g @zof/cli

Verify the installation:

zof --version

Expected result: zof/2.x.x

Step 2: Authenticate with Zof

Connect the CLI to your Zof account:

zof login

This opens your browser to complete authentication. Once authorized, you'll see:

✓ Authenticated as your@email.com

Step 3: Initialize your project

Navigate to your project directory and initialize Zof:

cd your-project
zof init

Zof creates a zof.config.json file with sensible defaults for your project type.

Step 4: Run your first test

Execute a quick validation:

zof run --quick

This runs a subset of agents for fast feedback (full runs take longer but are more comprehensive).

Verify it works

1. Open app.zof.ai
2. Navigate to Results
3. You should see your first test run with findings categorized by severity

You should see: A results summary showing reliability score, issues found, and test coverage.

Troubleshooting