Install
Add @opencoredev/email-sdk to your project and run the email-sdk CLI.
Email SDK is published on npm as @opencoredev/email-sdk. It runs server-side on Node 20+ and Bun 1.1+.
npm install @opencoredev/email-sdkImport the client from the package root and each adapter from its own entry point:
import { createEmailClient } from "@opencoredev/email-sdk";
import { resend } from "@opencoredev/email-sdk/resend";Package name vs. command name
The package is @opencoredev/email-sdk; the installed binary is email-sdk. The unscoped
email-sdk package on npm is an unrelated project, so don't npm install email-sdk.
Run the CLI
Once @opencoredev/email-sdk is in your project, the email-sdk binary is on your path:
npx email-sdk adaptersbunx email-sdk, pnpm exec email-sdk, and yarn email-sdk work the same way.
For a one-off check without touching a project, point bunx at the scoped package:
bunx --bun --package @opencoredev/email-sdk email-sdk adaptersThere is no safe no-install form for plain npx, because the unscoped email-sdk package
is unrelated. npm users should install first.
To put email-sdk on your path system-wide, without adding it to any project, install the
formula that ships in the repository:
brew install --formula https://raw.githubusercontent.com/opencoredev/email-sdk/main/Formula/email-sdk.rb
email-sdk adaptersThe formula installs the published npm tarball, uses Bun as its runtime,
and links the CLI as email-sdk. Each release opens an automated pull request that bumps
the formula's version and checksum, so the copy on main tracks the latest published
package.
Homebrew does not track formulas installed from a URL, so brew upgrade won't pick up new
versions; re-run the install command to update. A global install covers adapters, doctor,
and CLI sends. To import the SDK in application code, install the npm package as above.
Verify
npx email-sdk version
npx email-sdk adaptersadapters lists every supported provider with the environment variables it needs. To check that one provider is configured:
RESEND_API_KEY="re_..." npx email-sdk doctor --adapter resendKeep credentials server-side
Provider API keys belong in environment variables, or CLI flags for one-off commands. They have no business in browser bundles or client-side code; the SDK is a server library by design.
Ready to send? Continue with the quickstart.