31 lines (21 loc) · 1.12 KB

Capa Runtime Maintenance Guide

Project State

Repository: capa-cloud/capa
Category: Go sidecar/runtime for the Capa ecosystem
Public documentation: https://capa.rxcloud.group/
The runtime entry point is cmd/capa; reusable packages live under pkg/; API specs live under spec/.

Before Editing

Keep SDK/runtime boundaries explicit. This repo is the sidecar/runtime, not the language SDK.
Review spec/ changes together with SDK compatibility.
Avoid committing local binaries, generated reports, vendored dependencies, or real service credentials.

Useful Commands

Build: go build ./...
Test: go test ./...
Format: gofmt -w <changed-go-files>
Docker image: docker build -f docker/Dockerfile -t capa-runtime:local .

Environment

Configure the executable with the documented command-line flags.
Component-specific credentials should stay in local files or deployment secrets, not in the repository.

Deployment Notes

DEPLOYMENT.md records local Docker and sidecar deployment checks.
Do not describe actor, binding, or traffic interception roadmap items as implemented features.