agentleFS
lettr-comlettr-com/lettr-skills/install/SKILL.md

install

Skill0 starsChanged 5 months agoMITView on GitHub

Use when adding Lettr to a project for the first time. Detects the stack, installs the right SDK or framework integration, configures LETTR_API_KEY, verifies a sending domain, and optionally runs a test send.

  • Reads credentials

22 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use update and release.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • AnthropicSkill

    update

    Sync tasks and refresh memory from your current activity. Use when pulling new assignments from your project tracker into TASKS.md, triaging stale or overdue tasks, filling memory gaps for unknown people or projects, or running a comprehensive scan to catch todos buried in chat and email.

    Also in 3 projects that use this

  • MicrosoftSkill

    release

    Use ONLY when the user explicitly asks to cut/publish a Huabu desktop release or tag a version. Performs an outward action — bumps the version in apps/desktop/package.json, commits + annotated-tags vX.Y.Z, and pushes the branch + tag. That tag push auto-builds the macOS/Windows installers and publishes a GitHub Release. Provides `status`, `bump`, `tag-push`, and a one-command `run` (bump → tag-push).

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

6 rules. 0 are common, 0 are distinctive, and 6 are very specific to this project.

  • 0

    Common

    Most of the 18 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use ../_shared/detect-stack.md to resolve <lang>.

    line 12
  2. Very specific:

    Read ../_generated/sdk/<lang>/installation.md and follow it exactly — install command, client construction, where the key goes.

    line 16
  3. Very specific:

    Ask the user for LETTR_API_KEY if it isn't already in the environment or .env.

    line 22
  4. Very specific:

    Create it (POST /domains with domain).

    line 30
  5. Very specific:

    When they confirm, run POST /domains/{domain}/verify and re-check.

    line 32
  6. Very specific:

    No per-provider migration playbook ships here.

    line 44

“Common” is measured: kept by at least 6 in 10 of the 18 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Install Lettr

Get Lettr into the user's project: add the dependency, configure the key, make sure there's a verified domain to send from, and leave them with a working first send call.

1. Detect the stack

Use ../_shared/detect-stack.md to resolve <lang>. If nothing matches, follow its fallback (raw HTTP or SMTP relay) — there's no SDK to install in that case.

2. Install the SDK

Read ../_generated/sdk/<lang>/installation.md and follow it exactly — install command, client construction, where the key goes. It's generated from the official SDK docs, so the package name and API surface are current; don't install from memory.

For Laravel, prefer the package's own init command if the reference shows one (it writes config + env in one step).

3. Configure the API key

Ask the user for LETTR_API_KEY if it isn't already in the environment or .env. Keys start with lttr_. Put it in .env (never hardcoded), and confirm .env is gitignored.

Validate it: GET /auth/check returns the team ID on success. On 401, the key is wrong or revoked — have the user recreate it at app.lettr.com/settings/api-keys.

4. Make sure there's a verified sending domain

Sending from an unverified domain returns 400 with error_code: unconfigured_domain, and this is the single most common first-send failure. Check GET /domains. If the user's intended from domain isn't verified:

  1. Create it (POST /domains with domain). The response carries the DNS records to add (CNAME / DKIM / return-path).
  2. Hand those records to the user to apply at their DNS provider — this skill does not touch their registrar.
  3. When they confirm, run POST /domains/{domain}/verify and re-check.

5. Offer a test send

Ask whether to send a real test (it sends an actual email and uses quota). If yes, send a minimal email with a verified from to an address the user controls, and confirm the response includes a request_id. For composing anything beyond a hello-world, hand off to the sending skill.

6. Report what changed

Summarize: dependency added, files edited, env vars expected, domain status, and where the first real send call should go.

Replacing an existing email provider

No per-provider migration playbook ships here. Run this install alongside the old code, then read the existing send calls and rewrite them using the sending skill + the generated SDK reference. Remove the old dependency last, after a successful send.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.