📊Analysis & Triage
Create Reports for Stakeholders
Intermediate15 min read·Updated December 2024·Engineering Leaders
Generate executive summaries and team reports from Zof data.
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:
bash
npm install -g @zof/cliVerify the installation:
bash
zof --versionExpected result: zof/2.x.x
Step 2: Authenticate with Zof
Connect the CLI to your Zof account:
bash
zof loginThis opens your browser to complete authentication. Once authorized, you'll see:
text
✓ Authenticated as your@email.comTip
Use a service account token for CI rather than your personal token. You can create one at Settings → API Tokens in the Zof dashboard.
Step 3: Initialize your project
Navigate to your project directory and initialize Zof:
bash
cd your-project
zof initZof creates a zof.config.json file with sensible defaults for your project type.
Step 4: Run your first test
Execute a quick validation:
bash
zof run --quickThis runs a subset of agents for fast feedback (full runs take longer but are more comprehensive).
Note
The
--quick flag runs only smoke and sanity agents. Use zof run without flags for a comprehensive test.Verify it works
- Open app.zof.ai
- Navigate to Results
- 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
Next steps
Was this guide helpful?
