AGENTS.md

Agents

Before committing

Run all CI validations locally before committing changes:

make validate-all

This runs the same checks as CI:

1. go mod tidy — ensures go.mod/go.sum are clean
2. Lint — runs golangci-lint (see .golangci.yml for configuration)
3. Tests — runs all unit tests with race detection (go test -race ./...)
4. ShellCheck — validates all shell scripts

If any step fails, fix the issue and re-run before committing.

Prerequisites

• Go 1.25.6+
• golangci-lint v2.7.2+ — Install instructions
• ShellCheck — brew install shellcheck (macOS) or apt-get install shellcheck (Linux)

Project documentation

• README.md — project overview, building from source, API examples, and Makefile usage
• METRICS.md — aggregated metrics endpoint documentation
• Model CLI README — CLI plugin (docker model) documentation
• Helm chart — Kubernetes deployment guide
• Model Specification — model packaging specification
• Docker Docs — official Docker Model Runner documentation