IDE Integrations
GitHub Codespaces
Overview
Preconfigured devcontainer for Codespaces includes Node.js, Zof CLI, and SDK for immediate validation from cloud development environments.
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 devcontainer
Copy .devcontainer/devcontainer.json from Zof template in docs.
Rebuild container in Codespace.
Inject secrets
Add ZOF_API_KEY to Codespace secrets, not committed files.
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 excerpt
{
"features": { "ghcr.io/devcontainers/features/node:1": {} },
"postCreateCommand": "npm install -g @zof-ai/cli"
}Was this page helpful?