Adoption Path
Adoption Path
Section titled “Adoption Path”This page is the narrow adoption path for new Plumego users.
The first impression should be simple: standard-library HTTP compatibility, small stable kernel, explicit wiring, and machine-checkable agent workflow. Optional x/* packages are capability additions, not alternate bootstraps.
5 minutes: run one standard service
Section titled “5 minutes: run one standard service”Read:
- Getting Started
reference/standard-service/README.md
Use:
core.DefaultConfigcore.Newapp.Useapp.Getcontract.WriteResponsecontract.WriteError
Avoid:
x/*packages- custom response envelopes
- hidden route registration
Done when a local service responds from one explicit route using http.HandlerFunc.
30 minutes: add one capability
Section titled “30 minutes: add one capability”Keep reference/standard-service as the app shape. Add one capability family:
| Need | First read |
|---|---|
| CRUD / resource conventions | x/rest Primer |
| Tenant resolution and isolation | x/tenant Primer |
| Edge proxy and rewrite | x/gateway Primer |
| WebSocket transport | x/websocket Primer |
| Observability exporters | x/observability Primer |
| AI provider / session / tool primitives | x/ai Primer |
Done when the app still has explicit route wiring and only the selected capability family is added.
1 day: understand the control plane
Section titled “1 day: understand the control plane”Read:
AGENTS.md- Canonical Style Guide
- Agent-First Workflow
specs/repo.yamlspecs/dependency-rules.yaml- the target module’s
module.yaml
Done when a developer or agent can answer:
- which module owns the change
- which paths are out of scope
- whether stable public APIs are affected
- which validation commands must pass
Messaging rule
Section titled “Messaging rule”When updating README, website, or onboarding docs, present Plumego in this order:
- standard-library compatibility
- small stable kernel
- explicit reference application path
- machine-checkable agent workflow
- optional experimental capability catalog
Read next
Section titled “Read next”- Reference App — the canonical service shape to copy from
- Stable Roots — which packages carry the long-term promise
- x/* Family — how optional capabilities are organized
- When Not to Use Plumego — honest trade-off assessment