Package Guides
This hub helps you choose the right package entry point quickly.
- Read first: Package Selection
- Default starting point for most users: k-msg
- Drop lower when you need custom wiring: @k-msg/core
Quick picks
Section titled “Quick picks”| What you need now | Start with | Usually paired with |
|---|---|---|
| Send messages from an application | k-msg | @k-msg/provider |
| Implement a custom provider or control low-level behavior | @k-msg/core | @k-msg/provider, @k-msg/messaging |
| Queueing, delivery tracking, or runtime adapters | @k-msg/messaging | k-msg, @k-msg/provider |
| Heavy template parsing and interpolation | @k-msg/template | k-msg |
| Channel or sender-number admin tooling | @k-msg/channel | @k-msg/provider |
| Webhook runtime and retry flows | @k-msg/webhook | @k-msg/messaging |
| Reporting on delivery tracking data | @k-msg/analytics | @k-msg/messaging |
Recommended reading path
Section titled “Recommended reading path”- Most application teams: Package Selection -> k-msg -> Provider Selection -> Examples
- Platform or infrastructure teams: @k-msg/core -> @k-msg/messaging -> @k-msg/provider
- Admin or operations tooling teams: @k-msg/channel -> @k-msg/webhook -> @k-msg/analytics
Package directory
Section titled “Package directory”- @k-msg/analytics: Reporting and aggregation on top of delivery tracking data.
- @k-msg/channel: Provider-aware channel lifecycle helpers and in-memory toolkit helpers.
- @k-msg/core: Low-level types, Result, errors, and resilience primitives.
- @k-msg/messaging: Routing, queueing, delivery tracking, and runtime adapters behind KMsg.
- @k-msg/provider: Built-in provider implementations and onboarding metadata.
- @k-msg/template: Template parsing, interpolation, lifecycle, and toolkit utilities.
- @k-msg/webhook: Webhook runtime, persistence, retries, and Cloudflare adapters.
- k-msg: Unified facade most apps should start with.