Automate Workflows with the Zof API
Build custom automations and integrations using the Zof REST API.
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
By the end of this guide, you will have:
- Installed and authenticated the Zof CLI
- Connected Zof to your project
- Run 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/cliVerify the installation:
zof --versionExpected result: zof/2.x.x
Step 2: Authenticate with Zof
Connect the CLI to your Zof account:
zof loginThis opens your browser to complete authentication. Once authorized, you'll see:
✓ Authenticated as your@email.comTip
Step 3: Initialize your project
Navigate to your project directory and initialize Zof:
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:
zof run --quickThis runs a subset of agents for fast feedback (full runs take longer but are more comprehensive).
Note
--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
Cause: Your session may have expired or been revoked.
Solution: Run zof logout followed by zof login to re-authenticate.
Cause: You're not in a project directory or zof init wasn't run.
Solution: Navigate to your project root and run zof init.
Cause: Running full suite instead of quick mode.
Solution: Use zof run --quick for faster feedback during development, or configure specific agents in zof.config.json.
Next steps
Was this guide helpful?