Developers
Installation
Install CLI and SDK components for your environment.
Overview
Install CLI and SDK components for local development and CI runners. Console access requires only a modern browser with SSO or email OTP; no local install needed for operators.
Choose installation targets based on role: QA engineers typically need Console only; platform engineers install CLI in CI and SDK in services; SRE teams may add Agent Console endpoint agents on customer infrastructure.
Who should read this
- QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.
Prerequisites
- Node.js 18+ for CLI and Node SDK
- Organization membership with appropriate role
- Network egress to api.zof.ai from CI runners
When to use this workflow
- Onboarding new team members to Zof terminology and workflows
- Authoring internal runbooks aligned with Console labels
- Designing CI/CD or webhook integrations against documented behavior
Step-by-step procedure
CLI (global)
npm install -g @zof-ai/cli
Verify: zof --version
Authenticate: zof auth login
Node.js SDK
npm install @zof-ai/sdk in your project
Import ZofClient and pass ZOF_API_KEY from environment
Python SDK
pip install zof-ai
from zof import ZofClient; client = ZofClient(api_key=os.environ["ZOF_API_KEY"])
Go SDK
go get github.com/zof-ai/zof-go
Initialize client with option.WithAPIKey from environment
Java SDK
Add ai.zof:sdk to Maven dependencies
Configure ZofClient.builder().apiKey(...) from secrets
Key concepts
- Organization scope
- All Zof Console and API operations are isolated to your authenticated tenant.
- Governed execution
- Agent output and remediation follow policy packs with human approval when configured.
Best practices
- Pin CLI version in CI: npm install -g @zof-ai/cli@<version>
- Use devcontainer or CI cache for faster pipeline installs
- Verify install with zof projects list before wiring release gates
Was this page helpful?
