Developer Tools
Zof CLI Reference
Powerful command-line interface for running tests, managing agents, and integrating Zof into your development workflow.
Terminal
$ npm install -g @zof-ai/cliQuick Start
1
Install CLI
npm install -g @zof-ai/cli2
Authenticate
zof auth login3
Run Tests
zof test --type e2eCommand Reference
zof initInitialize Zof in your project
Example
$ zof init --project my-appOptions
--projectProject name--orgOrganization ID--tokenAPI token (or use ZOF_TOKEN env)zof testRun tests against your application
Example
$ zof test --type e2e --env stagingOptions
--typeTest type (e2e, api, security, load, etc.)--envTarget environment--parallelNumber of parallel workers--timeoutTest timeout in secondszof agentManage AI testing agents
Example
$ zof agent list --activeOptions
listList available agentsrunRun a specific agentstatusCheck agent statuszof graphInteract with the System Graph
Example
$ zof graph sync --branch mainOptions
syncSync codebase to graphqueryQuery the graphexportExport graph datazof reportGenerate and view test reports
Example
$ zof report --format html --output ./reportsOptions
--formatOutput format (html, json, junit)--outputOutput directory--openOpen in browser after generationzof ciCI/CD pipeline integration
Example
$ zof ci run --wait --fail-fastOptions
--waitWait for completion--fail-fastStop on first failure--coverageInclude coverage reportEnvironment Variables
| Variable | Description | Default |
|---|---|---|
ZOF_TOKEN | API authentication token | - |
ZOF_ORG_ID | Organization identifier | - |
ZOF_PROJECT | Default project name | - |
ZOF_ENV | Target environment | staging |
ZOF_LOG_LEVEL | Logging verbosity | info |
ZOF_TIMEOUT | Default timeout (seconds) | 300 |
Related Resources
Need Help?
Need Help?
Our support team is here to help you get the most out of Zof.