Skip to content

development.md

Latest commit

 

History

History
56 lines (40 loc) · 1.71 KB

development.md

File metadata and controls

56 lines (40 loc) · 1.71 KB
Raw

Development

Toolchain

  • Go 1.24+
  • CGO and a C compiler
  • Git
  • Docker with Compose for database-backed integration work

Local build

go mod download
make build
./bin/crisk --help

make build writes the CLI and pipeline binaries to bin/, which is ignored by Git.

Tests

go test ./...
go vet ./...

Run gofmt on changed Go files. The default Go suite should compile without external credentials. Shell integration tests under test/ require the services and fixtures described by the individual scripts.

Local data services

cp .env.example .env
# Replace example passwords and add only the credentials needed for your test.
docker compose up -d
docker compose ps

Default external ports are Neo4j HTTP 7475, Neo4j Bolt 7688, PostgreSQL 5433, and Redis 6380. These defaults are for isolated local development only.

Initialize the database schema with make init-db after the services are healthy. make clean-db deletes local CodeRisk database volumes; inspect the target environment before using it.

Repository layout

cmd/             CLI and pipeline executables
internal/        ingestion, graph, metrics, risk, MCP, and output packages
schema/          canonical PostgreSQL schema
migrations/      incremental schema history
scripts/schema/  staging and linking schemas
test/            fixtures and manual integration workflows
docs/            durable public documentation

Release state

GoReleaser configuration is retained so future tags can produce archives after CI is green. No release assets or Homebrew tap are currently supported. Any future installer must be tested against a published artifact before it is documented as an installation method.