๐ŸŒฌ๏ธ Breeze docs

Packages at a glance

Breeze is one Go module. Each row below is a package you can import directly; importing only what you use is the point of the split.

PackageImport pathDocs
HTTP coregithub.com/nelthaarion/breeze/v2Router, Context
Request bindingbreeze/bindingRequest Binding & Validation
Middlewarebreeze/middlewaresMiddleware Reference
OAuth2breeze/middlewares/oauth2OAuth2 / Social Login
Diagnosticsbreeze/diagDiagnostics
Eventsbreeze/eventsEvents
Workflowsbreeze/workflowWorkflows
Dashboardbreeze/dashboardDashboard
Observabilitybreeze/observabilityObservability
Fleet tracingbreeze/fleetFleet Tracing
Video streamingbreeze/videoVideo Streaming
JSON-RPC 2.0breeze/rpcJSON-RPC 2.0
OpenAPI / Scalarbreeze/scalarOpenAPI / Scalar
Migrationsbreeze/migrateMigrations
HTTP clientbreeze/clientHTTP Client
MCP (in-process)breeze/mcpMCP for AI Agents

events, workflow and observability never import the root package โ€” they work in a program that serves no HTTP at all. That is a deliberate dependency direction: the root breeze package imports binding, rpc, scalar and internal/mcp; dashboard imports breeze, events, observability and video; fleet imports dashboard. Nothing at the bottom of that graph knows the layers above it exist.

Where code lives

  • Repo root โ€” package breeze. The HTTP core and nothing else: router, Context, request/response, the Breeze server, worker pool, WebSocket engine, template engine, i18n, the error type, Auto-MCP route registration. A file belongs at root only if it is part of serving an HTTP request or is required to construct the server.
  • Subdirectories of root โ€” public subsystems. One directory per subsystem, importable by user code, and each can be left out of an application entirely.
  • internal/ โ€” machinery with no public API: the CLI's generator, the MCP server's implementation, shared flag parsing. Go enforces that nothing outside the module can import them.
  • cmd/ โ€” one directory per binary: shipped tools (breeze, breeze-mcp), runnable examples (<subsystem>-example), and other deployables (fleet-aggregator).

See Repository Conventions for the full set of rules โ€” naming, error handling, and where a new file should go.

Generated documentation for the Breeze framework ยท built with SvelteKit, fully static.