Overview

Generic devcontainer template standardizes Zof CLI and SDK versions across VS Code, Codespaces, and compatible editors for team onboarding.

New engineers run zof auth login on first container build without manual toolchain setup.

Who should read this

QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.

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

Add to repository

Create .devcontainer/devcontainer.json with Node 18 feature.

postCreateCommand: npm install -g @zof-ai/cli

Document secrets

README: set ZOF_API_KEY via devcontainer secrets or gitignored .env.local.

Verify setup

Rebuild container; run zof version and zof projects list.

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

Validate changes in staging before applying release gates to production.
Include run IDs and timestamps when escalating issues to support or auditors.
Align internal runbook terminology with Zof Console UI labels for clarity.

devcontainer.json

{
  "name": "Zof Dev",
  "features": { "ghcr.io/devcontainers/features/node:1": { "version": "18" } },
  "postCreateCommand": "npm install -g @zof-ai/cli"
}