CLI Reference

zof run

Execute validation runs.

Overview

Execute validation runs from the terminal or CI.

Contact Zof for CLI access for your deployment. Requires Node.js 18+ and ZOF_API_KEY or interactive auth.

Who should read this

  • Developers and CI pipelines invoking Zof from terminal environments.

Prerequisites

  • Node.js 18+
  • ZOF_API_KEY in environment or completed zof auth login

Step-by-step procedure

Verify install

Run zof version to confirm CLI availability.

Run zof auth whoami to confirm organization context.

Run command

$ zof run --project proj_abc --env staging

$ zof run --suite regression-core

Interpret exit code

0: success.

1: invalid flags or local error.

2: auth failure.

3: API error; check message and X-Request-Id.

Key concepts

Usage
zof run [--project ID] [--env staging] [--suite SUITE]
Exit codes
0 success; 1 command error; 2 authentication failure; 3 API error.

Best practices

  • Use --wait on zof run in CI to block until terminal status
  • Pin the CLI version provided for your deployment in pipelines
  • Prefer ZOF_API_KEY over interactive login in automation

Examples

$ zof run --project proj_abc --env staging
$ zof run --suite regression-core

Was this page helpful?