Skip to content

docs(sdk): add .env setup and anon key retrieval guide#25

Merged
tonychang04 merged 1 commit intomainfrom
docs/env-setup-anon-key
Apr 14, 2026
Merged

docs(sdk): add .env setup and anon key retrieval guide#25
tonychang04 merged 1 commit intomainfrom
docs/env-setup-anon-key

Conversation

@tonychang04
Copy link
Copy Markdown
Contributor

@tonychang04 tonychang04 commented Apr 9, 2026

Summary

  • Added .env setup instructions to main SDK SKILL.md with framework-specific variable prefixes and access patterns (process.env vs import.meta.env)
  • Documented how to get the anon key via npx @insforge/cli secrets get ANON_KEY
  • Updated all 6 module sdk-integration files (database, auth, storage, functions, realtime, ai) to reference env vars instead of hardcoded 'your-anon-key' placeholders

Test plan

  • Verify npx @insforge/cli secrets get ANON_KEY returns the anon key for a linked project
  • Confirm framework prefix table covers all supported frameworks
  • Test that skill triggers correctly and guides users through .env setup

🤖 Generated with Claude Code

Note

Add .env setup guide and npx @insforge/cli secrets get ANON_KEY retrieval steps to SDK docs

  • Expands SKILL.md with a step-by-step 'How to get your URL and anon key' subsection covering CLI project verification, fetching the anon key, finding the URL from oss_host, and writing both to .env with the correct framework prefix.
  • Updates the Setup intro in all six feature sdk-integration.md files (ai, auth, database, functions, realtime, storage) to reference the explicit npx @insforge/cli secrets get ANON_KEY command and point to SKILL.md for full setup details.

Macroscope summarized 0de6950.

Summary by CodeRabbit

  • Documentation
    • Enhanced environment setup instructions with dedicated section for obtaining credentials
    • Updated setup guides across all skill modules with CLI-based credential retrieval command
    • Added clarification on ensuring required configuration files exist before setup
    • Improved guidance on deriving connection URL from project configuration settings

Replace MCP tool references with `npx @insforge/cli secrets get ANON_KEY`
as the primary method for obtaining the anon key. All module files now
include the CLI command inline for quick reference.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 9, 2026

Walkthrough

Documentation across InsForge skill setup guides updated to standardize CLI-based ANON_KEY retrieval. The primary SKILL.md file expanded with a dedicated "How to get your URL and anon key" section showing npx @insforge/cli secrets get ANON_KEY workflow, while all sdk-integration files consistently updated to reference this expanded guidance.

Changes

Cohort / File(s) Summary
Main Setup Guide
skills/insforge/SKILL.md
Added dedicated section with step-by-step instructions for obtaining URL and anon key via CLI command, replacing prior get-anon-key MCP tool reference. Includes guidance on ensuring .insforge/project.json exists and deriving URL from oss_host field.
SDK Integration Guides
skills/insforge/*/sdk-integration.md (ai, auth, database, functions, realtime, storage)
Consistently updated setup instructions to include explicit npx @insforge/cli secrets get ANON_KEY command and expanded reference to SKILL.md for framework-specific variable names and complete setup steps.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • honoyomu
  • jwfing
  • Fermionic-Lyu

Poem

🐰✨ A hop through docs so clear and bright,
The CLI secrets now in sight,
No mystical tools need apply,
Just npx commands reaching high,
Six skills aligned, setup unified!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs(sdk): add .env setup and anon key retrieval guide' directly and accurately summarizes the main change: adding documentation for .env setup and anon key retrieval across SDK files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ 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 docs/env-setup-anon-key

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

@tonychang04 tonychang04 merged commit 8cfba03 into main Apr 14, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants