email cli auth docs

[drew-harris]

Docs explaining how to use instant-cli to manage the email templates

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 2d2b5a03-137c-4b1b-9fdd-fa86e7bf2a77

📥 Commits

Reviewing files that changed from the base of the PR and between ac2a8f3 and 0ee6d81.

📒 Files selected for processing (1)

• client/www/app/docs/cli/page.md

🚧 Files skipped from review as they are similar to previous changes (1)

• client/www/app/docs/cli/page.md

---

📝 Walkthrough

Walkthrough

Added a new "Magic Code Templates" section to the CLI docs describing the instant.email.ts template format, supported dynamic variables ({code}, {app_title}, {user_email}, {expiration}), the requirement that {code} appears in subject and body, an example payload, and CLI commands for pull/push/status/reset/verify/resend.

Changes

Magic Code Templates Documentation

Layer / File(s)	Summary
Magic Code Templates CLI documentation client/www/app/docs/cli/page.md	New "Magic Code Templates" subsection documenting the instant.email.ts file structure, supported dynamic variables ({code}, {app_title}, {user_email}, {expiration}) with {code} required in subject and body, example template object, and CLI commands (npx instant-cli@latest auth email pull, push, status, reset, verify, resend).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• instantdb/instant#2633: Related documentation and CLI email template command implementations.

Suggested reviewers

• stopachka
• dwwoelfel

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'email cli auth docs' is vague and lacks specificity about the actual change—it doesn't clearly indicate that the PR adds documentation for managing email templates via CLI commands.	Use a more descriptive title such as 'Add documentation for email template management via instant-cli' to better clarify the primary change.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description 'Docs explaining how to use instant-cli to manage the email templates' is directly related to the changeset, which adds a new documentation section on managing instant magic code email templates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch drewh/cli-email-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@client/www/app/docs/cli/page.md`:
- Around line 316-317: Update the wording for the CLI command "auth email reset"
to clarify that it is not local-only: state that the command deletes the app's
current server-side email template and then rewrites instant.email.ts locally,
and that a subsequent push is required to apply the rewritten template to the
server. Reference the command name ("auth email reset") and the file name
("instant.email.ts") in the copy so readers understand both the server-side
deletion and the local file rewrite.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 5b9d6fe4-beb2-4bfc-8f48-818829cdacac

📥 Commits

Reviewing files that changed from the base of the PR and between 7b81389 and f79bd3a.

📒 Files selected for processing (1)

• client/www/app/docs/cli/page.md

[nezaj]

LGTM w/ nits

[github-actions]

View Vercel preview at instant-www-js-drewh-cli-email-docs-jsv.vercel.app.