Skip to content

feat(init): support CLERK_PLATFORM_API_KEY for non-interactive auth#67

Merged
wyattjoh merged 1 commit into
mainfrom
wyattjoh/init-platform-api-key
Mar 31, 2026
Merged

feat(init): support CLERK_PLATFORM_API_KEY for non-interactive auth#67
wyattjoh merged 1 commit into
mainfrom
wyattjoh/init-platform-api-key

Conversation

@wyattjoh
Copy link
Copy Markdown
Contributor

@wyattjoh wyattjoh commented Mar 26, 2026 •
edited by coderabbitai Bot
Loading

Summary

  • Support CLERK_PLATFORM_API_KEY env var in clerk init and clerk link for non-interactive authentication
  • When set, the CLI skips the OAuth browser flow entirely, enabling CI/CD pipelines and automated scripts
  • link also bypasses token checks when the platform API key is present since PLAPI fetch helpers use it directly

Test plan

  • bun run test passes
  • bun run lint passes
  • clerk init works with OAuth flow (existing behavior unchanged)
  • CLERK_PLATFORM_API_KEY=<key> clerk init skips OAuth and links via API key

Summary by CodeRabbit

  • New Features
    • Users can now authenticate via API key environment variable during CLI setup, streamlining initialization and linking workflows without interactive login steps.

@wyattjoh wyattjoh force-pushed the wyattjoh/init-platform-api-key branch 3 times, most recently from 44f798f to b09f47f Compare March 27, 2026 22:10
@wyattjoh wyattjoh changed the title fix(init): Nuxt NuxtPage fix and CLERK_PLATFORM_API_KEY support feat(init): support CLERK_PLATFORM_API_KEY for non-interactive auth Mar 27, 2026
@wyattjoh wyattjoh changed the base branch from main to wyattjoh/init-nuxt-fix March 27, 2026 22:10
Base automatically changed from wyattjoh/init-nuxt-fix to main March 30, 2026 14:32
@wyattjoh
feat(init): support CLERK_PLATFORM_API_KEY for non-interactive auth
2705d7d 
Skip OAuth login when CLERK_PLATFORM_API_KEY is set in init and link.
The PLAPI fetch helpers already use this key directly for API calls,
so no token exchange is needed.
@wyattjoh wyattjoh force-pushed the wyattjoh/init-platform-api-key branch from b09f47f to 2705d7d Compare March 31, 2026 14:32
@wyattjoh
Copy link
Copy Markdown
Contributor Author

wyattjoh commented Mar 31, 2026

Stack

  1. feat(init): support CLERK_PLATFORM_API_KEY for non-interactive auth #67 feat(init): support CLERK_PLATFORM_API_KEY for non-interactive auth 👈
  2. test(e2e): add E2E test infrastructure and fixture projects #59 test(e2e): add E2E test infrastructure for clerk init
  3. test: harden e2e infra, colocate helpers, and add tooling configs #63 refactor(test): move test helpers and add documentation

This was referenced Mar 31, 2026
Merged
Merged
@wyattjoh wyattjoh marked this pull request as ready for review March 31, 2026 14:34
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 31, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 9ea0b29e-e7ee-4c3a-9699-8e04d0382564

📥 Commits

Reviewing files that changed from the base of the PR and between 4a8e5de and 2705d7d.

📒 Files selected for processing (2)
  • packages/cli-core/src/commands/init/index.ts
  • packages/cli-core/src/commands/link/index.ts
📝 Walkthrough

Walkthrough

The changes modify authentication and linking workflows in two CLI commands. In init/index.ts, the authenticateAndLink() function now checks for a Clerk platform API key environment variable at the start, resolves the profile early, and bypasses OAuth entirely when this key is present. Depending on whether a profile is resolved, it either links directly or proceeds with conditional linking. In link/index.ts, ensureAuth() returns early when the API key environment variable is set, skipping token retrieval and login fallback mechanisms.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: adding support for CLERK_PLATFORM_API_KEY environment variable for non-interactive authentication in the init command.

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

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

rafa-thayto
rafa-thayto approved these changes Mar 31, 2026
View reviewed changes
Comment thread packages/cli-core/src/commands/init/index.ts
}

async function authenticateAndLink(cwd: string): Promise<void> {
// If Platform API key is set, skip OAuth entirely
Copy link
Copy Markdown
Contributor

@rafa-thayto rafa-thayto Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL: we can run clerk cli without a PLAPI

@wyattjoh wyattjoh merged commit 713b802 into main Mar 31, 2026
4 checks passed
@wyattjoh wyattjoh deleted the wyattjoh/init-platform-api-key branch March 31, 2026 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rafa-thayto rafa-thayto rafa-thayto approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@wyattjoh @rafa-thayto