Developers

CLI

Command-line interface for execution, configuration, and pipeline integration.

Overview

The Zof CLI provides terminal access to authentication, project initialization, run execution, and report export, ideal for local developer workflows and CI/CD steps without custom HTTP code.

Contact Zof for CLI access for your deployment, then authenticate once per machine or CI runner. Configuration persists in zof.config.js at project root and environment variables for secrets.

Prerequisites

Node.js 18+
CLI access for your deployment, arranged with Zof
Organization API key or interactive login for CI

Step-by-step procedure

Get access

Contact Zof for CLI access for your deployment.

Verify: zof --version

Authenticate

zof auth login, opens browser for SSO or OTP.

For CI: export ZOF_API_KEY from secrets.

Initialize project

cd your-repo && zof init

Edit zof.config.js with project ID and environment.

Run validation

zof run --env staging

zof run --suite smoke, for named suite

zof.config.js

module.exports = {
  projectId: 'proj_abc123',
  defaultEnvironment: 'staging',
  failOnError: true,
};

Was this page helpful?