Package Reference
All packages are fully documented on pkg.go.dev.
Installation
go get github.com/DaniDeer/go-codex@latest
Go 1.26+ required.
Quick import reference
| What |
Import path |
| Core codecs |
github.com/DaniDeer/go-codex/codex |
| Format bridges (JSON, YAML, TOML, Gob, Binary (raw bytes)) |
github.com/DaniDeer/go-codex/format |
| Built-in constraints |
github.com/DaniDeer/go-codex/validate |
| REST API builder |
github.com/DaniDeer/go-codex/api/rest |
| Event channel builder |
github.com/DaniDeer/go-codex/api/events |
| MCP server builder |
github.com/DaniDeer/go-codex/api/mcp |
| net/http adapter (server + client) |
github.com/DaniDeer/go-codex/adapters/nethttp |
| chi adapter |
github.com/DaniDeer/go-codex/adapters/chi |
| Paho MQTT adapter |
github.com/DaniDeer/go-codex/adapters/mqtt |
| mark3labs/mcp-go adapter |
github.com/DaniDeer/go-codex/adapters/mcpgo |
| templ SSR format plug-in |
github.com/DaniDeer/go-codex/adapters/templ |
| OpenAPI 3.1 renderer |
github.com/DaniDeer/go-codex/render/openapi |
| AsyncAPI 3.0 renderer |
github.com/DaniDeer/go-codex/render/asyncapi/v3 |
| AsyncAPI 2.6 renderer (frozen) |
github.com/DaniDeer/go-codex/render/asyncapi/v2 |
| Forge pipelines |
github.com/DaniDeer/go-codex/forge |
| HTTP route descriptors |
github.com/DaniDeer/go-codex/route |
| Schema model |
github.com/DaniDeer/go-codex/schema |
| Observer interfaces |
github.com/DaniDeer/go-codex/stats |
Core
| Package |
Description |
pkg.go.dev |
codex |
⭐ Public API: Codec[T], primitives, struct, union, slice, constraints |
→ |
validate |
Reusable constraints: Email, UUID, URL, ranges, MQTT topics, binary file formats (PNG, JPEG, PDF, ZIP…), … |
→ |
format |
Format bridges: JSON, YAML, TOML, Gob, Binary (raw bytes), streaming, env vars, File I/O |
→ |
schema |
Schema model (pure data, zero dependencies) |
→ |
route |
HTTP route descriptors: Route, Param, SecurityScheme |
→ |
stats |
Observer interfaces: ValidationObserver, Observer, PipelineObserver, SecurityObserver, FileObserver; NoopObserver satisfies all five |
→ |
API builders (Layer 2)
| Package |
Description |
pkg.go.dev |
api/rest |
REST API builder: typed Decode/Encode + OpenAPI spec |
→ |
api/events |
Event channel builder: typed Decode/Encode + AsyncAPI spec |
→ |
api/mcp |
MCP server builder: Tools, Resources, Prompts |
→ |
Adapters
| Package |
Description |
pkg.go.dev |
adapters/nethttp |
net/http: server (Handler, Register) + client (Call) |
→ |
adapters/chi |
chi router adapter |
→ |
adapters/mqtt |
Paho MQTT: SubscribeHandler + Publish |
→ |
adapters/mcpgo |
mark3labs/mcp-go adapter |
→ |
adapters/templ |
templ SSR format plug-in |
→ |
Forge pipelines (Layer 3)
| Package |
Description |
pkg.go.dev |
forge |
Governed KPI functions: NewFunction, Compose, Registry |
→ |
Renderers
| Package |
Description |
pkg.go.dev |
render/openapi |
OpenAPI 3.1 spec renderer |
→ |
render/asyncapi/v3 |
AsyncAPI 3.0 spec renderer |
→ |
render/asyncapi/v2 |
AsyncAPI 2.6 spec renderer (frozen) |
→ |
render/jsonschema |
JSON Schema renderer (used by api/mcp) |
→ |
render/pipeline |
Pipeline YAML renderer (used by forge) |
→ |