Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,11 +51,13 @@ clerk init
--framework <name> Framework to set up (skips auto-detection)
--prompt Output a prompt for an AI agent to integrate Clerk
--yes Skip confirmation prompts
--no-skills Skip the optional agent skills install prompt
Examples:
$ clerk init Auto-detect framework and set up Clerk
$ clerk init --framework next Set up for Next.js (skips detection)
$ clerk init --prompt Output a setup prompt for an AI agent
$ clerk init -y Skip all confirmation prompts
$ clerk init --no-skills Skip the agent skills install prompt

clerk auth login Log in via browser (OAuth)
clerk auth logout Remove stored credentials
Expand Down
27 changes: 27 additions & 0 deletions packages/cli-core/src/commands/init/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ clerk init --framework next
clerk init --prompt
clerk init -y
clerk init --yes
clerk init --no-skills
```

## Options
Expand All@@ -19,6 +20,7 @@ clerk init --yes
| `--framework <name>` | Framework to set up (skips auto-detection). Valid values: `next`, `astro`, `nuxt`, `tanstack-start`, `react-router`, `vue`, `expo`, `react`, `express`, `fastify` |
| `--prompt` | Output a prompt for an AI agent to integrate Clerk, then exit |
| `-y, --yes` | Skip confirmation prompts |
| `--no-skills` | Skip the optional agent skills install prompt at the end of init |

## Agent Mode

Expand DownExpand Up@@ -46,6 +48,7 @@ When running in agent mode (`--mode agent` or non-TTY), outputs a framework-spec
14. Prints a summary of created, modified, and skipped files with recommendations
15. **Authenticated mode**: pulls development instance API keys via `clerk env pull`
16. **Keyless mode**: prints instructions for keyless development and how to connect a Clerk account later
17. Optionally installs framework-specific Clerk agent skills via `npx skills add` (see [Agent skills install](#agent-skills-install))

## Framework Detection

Expand DownExpand Up@@ -148,6 +151,30 @@ Nuxt's module system auto-configures middleware and auto-imports components.
| MODIFY | `src/router/index.ts` | Add sign-in and sign-up routes (if router exists) |
| MODIFY | `.env` | Add sign-in/sign-up route env vars (VITE\_ prefix) |

## Agent skills install

After scaffolding (and after env keys are pulled or keyless instructions are printed), `clerk init` offers to install Clerk's framework-specific agent skills from [`clerk/skills`](https://github.com/clerk/skills) via `npx skills add`. This step is optional and non-fatal: if `npx` is missing or the install command exits non-zero, init prints a yellow warning with the manual install command and still exits successfully.

- **Human mode**: prompts `Install agent skills? (...)` defaulting to yes. Pass `--no-skills` to suppress the prompt entirely, or `-y/--yes` to accept it without confirmation.
- **Agent mode / `--prompt`**: `clerk init` exits early before the skills step runs (see the `if (options.prompt || isAgent()) { ... return }` branch in [`index.ts`](./index.ts)), so nothing is installed. Agent users should run `npx skills add clerk/skills` manually, or have their agent do it.

The base skills `clerk` and `clerk-setup` are always included. The detected framework dependency adds a matching skill:

| Framework dep | Added skill |
| ----------------------- | ----------------------------- |
| `next` | `clerk-nextjs-patterns` |
| `react` | `clerk-react-patterns` |
| `react-router` | `clerk-react-router-patterns` |
| `vue` | `clerk-vue-patterns` |
| `nuxt` | `clerk-nuxt-patterns` |
| `astro` | `clerk-astro-patterns` |
| `@tanstack/react-start` | `clerk-tanstack-patterns` |
| `expo` | `clerk-expo-patterns` |
| `express` | `clerk-backend-api` |
| `fastify` | `clerk-backend-api` |

Implementation lives in [`skills.ts`](./skills.ts). Note that the E2E fixture setup runs `clerk init --yes --no-skills` because the skill templates reference framework-generated types (e.g. React Router's `./+types/root`) that don't exist outside a real app directory and would break the fixture's `tsc` step.

## API Endpoints

See [auth/README.md](../auth/README.md), [link/README.md](../link/README.md), and [env/README.md](../env/README.md) for the API endpoints used by each step.
2 changes: 2 additions & 0 deletions packages/cli-core/src/commands/init/index.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import * as previewMod from "./preview.ts";
import * as formatMod from "./format.ts";
import * as scanMod from "./scan.ts";
import * as heuristics from "./heuristics.ts";
import * as skillsMod from "./skills.ts";
import { init } from "./index.ts";

describe("init command", () => {
Expand DownExpand Up@@ -45,6 +46,7 @@ describe("init command", () => {
spyOn(heuristics, "writePlan").mockResolvedValue([]),
spyOn(heuristics, "checkGitDirty").mockResolvedValue(false),
spyOn(heuristics, "printOutro").mockReturnValue(undefined),
spyOn(skillsMod, "installSkills").mockResolvedValue(undefined),
spyOn(linkMod, "link").mockResolvedValue(undefined),
spyOn(pullMod, "pull").mockResolvedValue(undefined),
];
Expand Down
28 changes: 21 additions & 7 deletions packages/cli-core/src/commands/init/skills.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,13 +72,27 @@ export async function installSkills(
const interactive = isHuman() && !skipPrompt;
const args = buildSkillsArgs(skills, interactive);

const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
const exitCode = await proc.exited;
// Skills are optional — soft-fail with a warning rather than tearing down
// a successful scaffold. Bun.spawn can throw synchronously when the binary
// is missing (e.g. `npx` not on PATH on a minimal CI image), so the
// try/catch is needed in addition to the exit code check below.
let exitCode: number;
try {
const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
exitCode = await proc.exited;
} catch {
console.log(
yellow(
`\nCould not run \`npx skills add\`. You can install manually later: npx skills add ${SKILLS_SOURCE}`,
),
);
return;
}

if (exitCode !== 0) {
console.log(
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,11 +51,13 @@ clerk init
--framework <name> Framework to set up (skips auto-detection)
--prompt Output a prompt for an AI agent to integrate Clerk
--yes Skip confirmation prompts
--no-skills Skip the optional agent skills install prompt
Examples:
$ clerk init Auto-detect framework and set up Clerk
$ clerk init --framework next Set up for Next.js (skips detection)
$ clerk init --prompt Output a setup prompt for an AI agent
$ clerk init -y Skip all confirmation prompts
$ clerk init --no-skills Skip the agent skills install prompt

clerk auth login Log in via browser (OAuth)
clerk auth logout Remove stored credentials
Expand Down
27 changes: 27 additions & 0 deletions packages/cli-core/src/commands/init/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ clerk init --framework next
clerk init --prompt
clerk init -y
clerk init --yes
clerk init --no-skills
```

## Options
Expand All@@ -19,6 +20,7 @@ clerk init --yes
| `--framework <name>` | Framework to set up (skips auto-detection). Valid values: `next`, `astro`, `nuxt`, `tanstack-start`, `react-router`, `vue`, `expo`, `react`, `express`, `fastify` |
| `--prompt` | Output a prompt for an AI agent to integrate Clerk, then exit |
| `-y, --yes` | Skip confirmation prompts |
| `--no-skills` | Skip the optional agent skills install prompt at the end of init |

## Agent Mode

Expand DownExpand Up@@ -46,6 +48,7 @@ When running in agent mode (`--mode agent` or non-TTY), outputs a framework-spec
14. Prints a summary of created, modified, and skipped files with recommendations
15. **Authenticated mode**: pulls development instance API keys via `clerk env pull`
16. **Keyless mode**: prints instructions for keyless development and how to connect a Clerk account later
17. Optionally installs framework-specific Clerk agent skills via `npx skills add` (see [Agent skills install](#agent-skills-install))

## Framework Detection

Expand DownExpand Up@@ -148,6 +151,30 @@ Nuxt's module system auto-configures middleware and auto-imports components.
| MODIFY | `src/router/index.ts` | Add sign-in and sign-up routes (if router exists) |
| MODIFY | `.env` | Add sign-in/sign-up route env vars (VITE\_ prefix) |

## Agent skills install

After scaffolding (and after env keys are pulled or keyless instructions are printed), `clerk init` offers to install Clerk's framework-specific agent skills from [`clerk/skills`](https://github.com/clerk/skills) via `npx skills add`. This step is optional and non-fatal: if `npx` is missing or the install command exits non-zero, init prints a yellow warning with the manual install command and still exits successfully.

- **Human mode**: prompts `Install agent skills? (...)` defaulting to yes. Pass `--no-skills` to suppress the prompt entirely, or `-y/--yes` to accept it without confirmation.
- **Agent mode / `--prompt`**: `clerk init` exits early before the skills step runs (see the `if (options.prompt || isAgent()) { ... return }` branch in [`index.ts`](./index.ts)), so nothing is installed. Agent users should run `npx skills add clerk/skills` manually, or have their agent do it.

The base skills `clerk` and `clerk-setup` are always included. The detected framework dependency adds a matching skill:

| Framework dep | Added skill |
| ----------------------- | ----------------------------- |
| `next` | `clerk-nextjs-patterns` |
| `react` | `clerk-react-patterns` |
| `react-router` | `clerk-react-router-patterns` |
| `vue` | `clerk-vue-patterns` |
| `nuxt` | `clerk-nuxt-patterns` |
| `astro` | `clerk-astro-patterns` |
| `@tanstack/react-start` | `clerk-tanstack-patterns` |
| `expo` | `clerk-expo-patterns` |
| `express` | `clerk-backend-api` |
| `fastify` | `clerk-backend-api` |

Implementation lives in [`skills.ts`](./skills.ts). Note that the E2E fixture setup runs `clerk init --yes --no-skills` because the skill templates reference framework-generated types (e.g. React Router's `./+types/root`) that don't exist outside a real app directory and would break the fixture's `tsc` step.

## API Endpoints

See [auth/README.md](../auth/README.md), [link/README.md](../link/README.md), and [env/README.md](../env/README.md) for the API endpoints used by each step.
2 changes: 2 additions & 0 deletions packages/cli-core/src/commands/init/index.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import * as previewMod from "./preview.ts";
import * as formatMod from "./format.ts";
import * as scanMod from "./scan.ts";
import * as heuristics from "./heuristics.ts";
import * as skillsMod from "./skills.ts";
import { init } from "./index.ts";

describe("init command", () => {
Expand DownExpand Up@@ -45,6 +46,7 @@ describe("init command", () => {
spyOn(heuristics, "writePlan").mockResolvedValue([]),
spyOn(heuristics, "checkGitDirty").mockResolvedValue(false),
spyOn(heuristics, "printOutro").mockReturnValue(undefined),
spyOn(skillsMod, "installSkills").mockResolvedValue(undefined),
spyOn(linkMod, "link").mockResolvedValue(undefined),
spyOn(pullMod, "pull").mockResolvedValue(undefined),
];
Expand Down
28 changes: 21 additions & 7 deletions packages/cli-core/src/commands/init/skills.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,13 +72,27 @@ export async function installSkills(
const interactive = isHuman() && !skipPrompt;
const args = buildSkillsArgs(skills, interactive);

const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
const exitCode = await proc.exited;
// Skills are optional — soft-fail with a warning rather than tearing down
// a successful scaffold. Bun.spawn can throw synchronously when the binary
// is missing (e.g. `npx` not on PATH on a minimal CI image), so the
// try/catch is needed in addition to the exit code check below.
let exitCode: number;
try {
const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
exitCode = await proc.exited;
} catch {
console.log(
yellow(
`\nCould not run \`npx skills add\`. You can install manually later: npx skills add ${SKILLS_SOURCE}`,
),
);
return;
}

if (exitCode !== 0) {
console.log(
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,11 +51,13 @@ clerk init
--framework <name> Framework to set up (skips auto-detection)
--prompt Output a prompt for an AI agent to integrate Clerk
--yes Skip confirmation prompts
--no-skills Skip the optional agent skills install prompt
Examples:
$ clerk init Auto-detect framework and set up Clerk
$ clerk init --framework next Set up for Next.js (skips detection)
$ clerk init --prompt Output a setup prompt for an AI agent
$ clerk init -y Skip all confirmation prompts
$ clerk init --no-skills Skip the agent skills install prompt

clerk auth login Log in via browser (OAuth)
clerk auth logout Remove stored credentials
Expand Down
27 changes: 27 additions & 0 deletions packages/cli-core/src/commands/init/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ clerk init --framework next
clerk init --prompt
clerk init -y
clerk init --yes
clerk init --no-skills
```

## Options
Expand All@@ -19,6 +20,7 @@ clerk init --yes
| `--framework <name>` | Framework to set up (skips auto-detection). Valid values: `next`, `astro`, `nuxt`, `tanstack-start`, `react-router`, `vue`, `expo`, `react`, `express`, `fastify` |
| `--prompt` | Output a prompt for an AI agent to integrate Clerk, then exit |
| `-y, --yes` | Skip confirmation prompts |
| `--no-skills` | Skip the optional agent skills install prompt at the end of init |

## Agent Mode

Expand DownExpand Up@@ -46,6 +48,7 @@ When running in agent mode (`--mode agent` or non-TTY), outputs a framework-spec
14. Prints a summary of created, modified, and skipped files with recommendations
15. **Authenticated mode**: pulls development instance API keys via `clerk env pull`
16. **Keyless mode**: prints instructions for keyless development and how to connect a Clerk account later
17. Optionally installs framework-specific Clerk agent skills via `npx skills add` (see [Agent skills install](#agent-skills-install))

## Framework Detection

Expand DownExpand Up@@ -148,6 +151,30 @@ Nuxt's module system auto-configures middleware and auto-imports components.
| MODIFY | `src/router/index.ts` | Add sign-in and sign-up routes (if router exists) |
| MODIFY | `.env` | Add sign-in/sign-up route env vars (VITE\_ prefix) |

## Agent skills install

After scaffolding (and after env keys are pulled or keyless instructions are printed), `clerk init` offers to install Clerk's framework-specific agent skills from [`clerk/skills`](https://github.com/clerk/skills) via `npx skills add`. This step is optional and non-fatal: if `npx` is missing or the install command exits non-zero, init prints a yellow warning with the manual install command and still exits successfully.

- **Human mode**: prompts `Install agent skills? (...)` defaulting to yes. Pass `--no-skills` to suppress the prompt entirely, or `-y/--yes` to accept it without confirmation.
- **Agent mode / `--prompt`**: `clerk init` exits early before the skills step runs (see the `if (options.prompt || isAgent()) { ... return }` branch in [`index.ts`](./index.ts)), so nothing is installed. Agent users should run `npx skills add clerk/skills` manually, or have their agent do it.

The base skills `clerk` and `clerk-setup` are always included. The detected framework dependency adds a matching skill:

| Framework dep | Added skill |
| ----------------------- | ----------------------------- |
| `next` | `clerk-nextjs-patterns` |
| `react` | `clerk-react-patterns` |
| `react-router` | `clerk-react-router-patterns` |
| `vue` | `clerk-vue-patterns` |
| `nuxt` | `clerk-nuxt-patterns` |
| `astro` | `clerk-astro-patterns` |
| `@tanstack/react-start` | `clerk-tanstack-patterns` |
| `expo` | `clerk-expo-patterns` |
| `express` | `clerk-backend-api` |
| `fastify` | `clerk-backend-api` |

Implementation lives in [`skills.ts`](./skills.ts). Note that the E2E fixture setup runs `clerk init --yes --no-skills` because the skill templates reference framework-generated types (e.g. React Router's `./+types/root`) that don't exist outside a real app directory and would break the fixture's `tsc` step.

## API Endpoints

See [auth/README.md](../auth/README.md), [link/README.md](../link/README.md), and [env/README.md](../env/README.md) for the API endpoints used by each step.
2 changes: 2 additions & 0 deletions packages/cli-core/src/commands/init/index.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import * as previewMod from "./preview.ts";
import * as formatMod from "./format.ts";
import * as scanMod from "./scan.ts";
import * as heuristics from "./heuristics.ts";
import * as skillsMod from "./skills.ts";
import { init } from "./index.ts";

describe("init command", () => {
Expand DownExpand Up@@ -45,6 +46,7 @@ describe("init command", () => {
spyOn(heuristics, "writePlan").mockResolvedValue([]),
spyOn(heuristics, "checkGitDirty").mockResolvedValue(false),
spyOn(heuristics, "printOutro").mockReturnValue(undefined),
spyOn(skillsMod, "installSkills").mockResolvedValue(undefined),
spyOn(linkMod, "link").mockResolvedValue(undefined),
spyOn(pullMod, "pull").mockResolvedValue(undefined),
];
Expand Down
28 changes: 21 additions & 7 deletions packages/cli-core/src/commands/init/skills.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,13 +72,27 @@ export async function installSkills(
const interactive = isHuman() && !skipPrompt;
const args = buildSkillsArgs(skills, interactive);

const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
const exitCode = await proc.exited;
// Skills are optional — soft-fail with a warning rather than tearing down
// a successful scaffold. Bun.spawn can throw synchronously when the binary
// is missing (e.g. `npx` not on PATH on a minimal CI image), so the
// try/catch is needed in addition to the exit code check below.
let exitCode: number;
try {
const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
exitCode = await proc.exited;
} catch {
console.log(
yellow(
`\nCould not run \`npx skills add\`. You can install manually later: npx skills add ${SKILLS_SOURCE}`,
),
);
return;
}

if (exitCode !== 0) {
console.log(
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,11 +51,13 @@ clerk init
--framework <name> Framework to set up (skips auto-detection)
--prompt Output a prompt for an AI agent to integrate Clerk
--yes Skip confirmation prompts
--no-skills Skip the optional agent skills install prompt
Examples:
$ clerk init Auto-detect framework and set up Clerk
$ clerk init --framework next Set up for Next.js (skips detection)
$ clerk init --prompt Output a setup prompt for an AI agent
$ clerk init -y Skip all confirmation prompts
$ clerk init --no-skills Skip the agent skills install prompt

clerk auth login Log in via browser (OAuth)
clerk auth logout Remove stored credentials
Expand Down
27 changes: 27 additions & 0 deletions packages/cli-core/src/commands/init/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ clerk init --framework next
clerk init --prompt
clerk init -y
clerk init --yes
clerk init --no-skills
```

## Options
Expand All@@ -19,6 +20,7 @@ clerk init --yes
| `--framework <name>` | Framework to set up (skips auto-detection). Valid values: `next`, `astro`, `nuxt`, `tanstack-start`, `react-router`, `vue`, `expo`, `react`, `express`, `fastify` |
| `--prompt` | Output a prompt for an AI agent to integrate Clerk, then exit |
| `-y, --yes` | Skip confirmation prompts |
| `--no-skills` | Skip the optional agent skills install prompt at the end of init |

## Agent Mode

Expand DownExpand Up@@ -46,6 +48,7 @@ When running in agent mode (`--mode agent` or non-TTY), outputs a framework-spec
14. Prints a summary of created, modified, and skipped files with recommendations
15. **Authenticated mode**: pulls development instance API keys via `clerk env pull`
16. **Keyless mode**: prints instructions for keyless development and how to connect a Clerk account later
17. Optionally installs framework-specific Clerk agent skills via `npx skills add` (see [Agent skills install](#agent-skills-install))

## Framework Detection

Expand DownExpand Up@@ -148,6 +151,30 @@ Nuxt's module system auto-configures middleware and auto-imports components.
| MODIFY | `src/router/index.ts` | Add sign-in and sign-up routes (if router exists) |
| MODIFY | `.env` | Add sign-in/sign-up route env vars (VITE\_ prefix) |

## Agent skills install

After scaffolding (and after env keys are pulled or keyless instructions are printed), `clerk init` offers to install Clerk's framework-specific agent skills from [`clerk/skills`](https://github.com/clerk/skills) via `npx skills add`. This step is optional and non-fatal: if `npx` is missing or the install command exits non-zero, init prints a yellow warning with the manual install command and still exits successfully.

- **Human mode**: prompts `Install agent skills? (...)` defaulting to yes. Pass `--no-skills` to suppress the prompt entirely, or `-y/--yes` to accept it without confirmation.
- **Agent mode / `--prompt`**: `clerk init` exits early before the skills step runs (see the `if (options.prompt || isAgent()) { ... return }` branch in [`index.ts`](./index.ts)), so nothing is installed. Agent users should run `npx skills add clerk/skills` manually, or have their agent do it.

The base skills `clerk` and `clerk-setup` are always included. The detected framework dependency adds a matching skill:

| Framework dep | Added skill |
| ----------------------- | ----------------------------- |
| `next` | `clerk-nextjs-patterns` |
| `react` | `clerk-react-patterns` |
| `react-router` | `clerk-react-router-patterns` |
| `vue` | `clerk-vue-patterns` |
| `nuxt` | `clerk-nuxt-patterns` |
| `astro` | `clerk-astro-patterns` |
| `@tanstack/react-start` | `clerk-tanstack-patterns` |
| `expo` | `clerk-expo-patterns` |
| `express` | `clerk-backend-api` |
| `fastify` | `clerk-backend-api` |

Implementation lives in [`skills.ts`](./skills.ts). Note that the E2E fixture setup runs `clerk init --yes --no-skills` because the skill templates reference framework-generated types (e.g. React Router's `./+types/root`) that don't exist outside a real app directory and would break the fixture's `tsc` step.

## API Endpoints

See [auth/README.md](../auth/README.md), [link/README.md](../link/README.md), and [env/README.md](../env/README.md) for the API endpoints used by each step.
2 changes: 2 additions & 0 deletions packages/cli-core/src/commands/init/index.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import * as previewMod from "./preview.ts";
import * as formatMod from "./format.ts";
import * as scanMod from "./scan.ts";
import * as heuristics from "./heuristics.ts";
import * as skillsMod from "./skills.ts";
import { init } from "./index.ts";

describe("init command", () => {
Expand DownExpand Up@@ -45,6 +46,7 @@ describe("init command", () => {
spyOn(heuristics, "writePlan").mockResolvedValue([]),
spyOn(heuristics, "checkGitDirty").mockResolvedValue(false),
spyOn(heuristics, "printOutro").mockReturnValue(undefined),
spyOn(skillsMod, "installSkills").mockResolvedValue(undefined),
spyOn(linkMod, "link").mockResolvedValue(undefined),
spyOn(pullMod, "pull").mockResolvedValue(undefined),
];
Expand Down
28 changes: 21 additions & 7 deletions packages/cli-core/src/commands/init/skills.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,13 +72,27 @@ export async function installSkills(
const interactive = isHuman() && !skipPrompt;
const args = buildSkillsArgs(skills, interactive);

const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
const exitCode = await proc.exited;
// Skills are optional — soft-fail with a warning rather than tearing down
// a successful scaffold. Bun.spawn can throw synchronously when the binary
// is missing (e.g. `npx` not on PATH on a minimal CI image), so the
// try/catch is needed in addition to the exit code check below.
let exitCode: number;
try {
const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
exitCode = await proc.exited;
} catch {
console.log(
yellow(
`\nCould not run \`npx skills add\`. You can install manually later: npx skills add ${SKILLS_SOURCE}`,
),
);
return;
}

if (exitCode !== 0) {
console.log(
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,11 +51,13 @@ clerk init
--framework <name> Framework to set up (skips auto-detection)
--prompt Output a prompt for an AI agent to integrate Clerk
--yes Skip confirmation prompts
--no-skills Skip the optional agent skills install prompt
Examples:
$ clerk init Auto-detect framework and set up Clerk
$ clerk init --framework next Set up for Next.js (skips detection)
$ clerk init --prompt Output a setup prompt for an AI agent
$ clerk init -y Skip all confirmation prompts
$ clerk init --no-skills Skip the agent skills install prompt

clerk auth login Log in via browser (OAuth)
clerk auth logout Remove stored credentials
Expand Down
27 changes: 27 additions & 0 deletions packages/cli-core/src/commands/init/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ clerk init --framework next
clerk init --prompt
clerk init -y
clerk init --yes
clerk init --no-skills
```

## Options
Expand All@@ -19,6 +20,7 @@ clerk init --yes
| `--framework <name>` | Framework to set up (skips auto-detection). Valid values: `next`, `astro`, `nuxt`, `tanstack-start`, `react-router`, `vue`, `expo`, `react`, `express`, `fastify` |
| `--prompt` | Output a prompt for an AI agent to integrate Clerk, then exit |
| `-y, --yes` | Skip confirmation prompts |
| `--no-skills` | Skip the optional agent skills install prompt at the end of init |

## Agent Mode

Expand DownExpand Up@@ -46,6 +48,7 @@ When running in agent mode (`--mode agent` or non-TTY), outputs a framework-spec
14. Prints a summary of created, modified, and skipped files with recommendations
15. **Authenticated mode**: pulls development instance API keys via `clerk env pull`
16. **Keyless mode**: prints instructions for keyless development and how to connect a Clerk account later
17. Optionally installs framework-specific Clerk agent skills via `npx skills add` (see [Agent skills install](#agent-skills-install))

## Framework Detection

Expand DownExpand Up@@ -148,6 +151,30 @@ Nuxt's module system auto-configures middleware and auto-imports components.
| MODIFY | `src/router/index.ts` | Add sign-in and sign-up routes (if router exists) |
| MODIFY | `.env` | Add sign-in/sign-up route env vars (VITE\_ prefix) |

## Agent skills install

After scaffolding (and after env keys are pulled or keyless instructions are printed), `clerk init` offers to install Clerk's framework-specific agent skills from [`clerk/skills`](https://github.com/clerk/skills) via `npx skills add`. This step is optional and non-fatal: if `npx` is missing or the install command exits non-zero, init prints a yellow warning with the manual install command and still exits successfully.

- **Human mode**: prompts `Install agent skills? (...)` defaulting to yes. Pass `--no-skills` to suppress the prompt entirely, or `-y/--yes` to accept it without confirmation.
- **Agent mode / `--prompt`**: `clerk init` exits early before the skills step runs (see the `if (options.prompt || isAgent()) { ... return }` branch in [`index.ts`](./index.ts)), so nothing is installed. Agent users should run `npx skills add clerk/skills` manually, or have their agent do it.

The base skills `clerk` and `clerk-setup` are always included. The detected framework dependency adds a matching skill:

| Framework dep | Added skill |
| ----------------------- | ----------------------------- |
| `next` | `clerk-nextjs-patterns` |
| `react` | `clerk-react-patterns` |
| `react-router` | `clerk-react-router-patterns` |
| `vue` | `clerk-vue-patterns` |
| `nuxt` | `clerk-nuxt-patterns` |
| `astro` | `clerk-astro-patterns` |
| `@tanstack/react-start` | `clerk-tanstack-patterns` |
| `expo` | `clerk-expo-patterns` |
| `express` | `clerk-backend-api` |
| `fastify` | `clerk-backend-api` |

Implementation lives in [`skills.ts`](./skills.ts). Note that the E2E fixture setup runs `clerk init --yes --no-skills` because the skill templates reference framework-generated types (e.g. React Router's `./+types/root`) that don't exist outside a real app directory and would break the fixture's `tsc` step.

## API Endpoints

See [auth/README.md](../auth/README.md), [link/README.md](../link/README.md), and [env/README.md](../env/README.md) for the API endpoints used by each step.
2 changes: 2 additions & 0 deletions packages/cli-core/src/commands/init/index.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import * as previewMod from "./preview.ts";
import * as formatMod from "./format.ts";
import * as scanMod from "./scan.ts";
import * as heuristics from "./heuristics.ts";
import * as skillsMod from "./skills.ts";
import { init } from "./index.ts";

describe("init command", () => {
Expand DownExpand Up@@ -45,6 +46,7 @@ describe("init command", () => {
spyOn(heuristics, "writePlan").mockResolvedValue([]),
spyOn(heuristics, "checkGitDirty").mockResolvedValue(false),
spyOn(heuristics, "printOutro").mockReturnValue(undefined),
spyOn(skillsMod, "installSkills").mockResolvedValue(undefined),
spyOn(linkMod, "link").mockResolvedValue(undefined),
spyOn(pullMod, "pull").mockResolvedValue(undefined),
];
Expand Down
28 changes: 21 additions & 7 deletions packages/cli-core/src/commands/init/skills.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,13 +72,27 @@ export async function installSkills(
const interactive = isHuman() && !skipPrompt;
const args = buildSkillsArgs(skills, interactive);

const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
const exitCode = await proc.exited;
// Skills are optional — soft-fail with a warning rather than tearing down
// a successful scaffold. Bun.spawn can throw synchronously when the binary
// is missing (e.g. `npx` not on PATH on a minimal CI image), so the
// try/catch is needed in addition to the exit code check below.
let exitCode: number;
try {
const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
exitCode = await proc.exited;
} catch {
console.log(
yellow(
`\nCould not run \`npx skills add\`. You can install manually later: npx skills add ${SKILLS_SOURCE}`,
),
);
return;
}

if (exitCode !== 0) {
console.log(
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,11 +51,13 @@ clerk init
--framework <name> Framework to set up (skips auto-detection)
--prompt Output a prompt for an AI agent to integrate Clerk
--yes Skip confirmation prompts
--no-skills Skip the optional agent skills install prompt
Examples:
$ clerk init Auto-detect framework and set up Clerk
$ clerk init --framework next Set up for Next.js (skips detection)
$ clerk init --prompt Output a setup prompt for an AI agent
$ clerk init -y Skip all confirmation prompts
$ clerk init --no-skills Skip the agent skills install prompt

clerk auth login Log in via browser (OAuth)
clerk auth logout Remove stored credentials
Expand Down
27 changes: 27 additions & 0 deletions packages/cli-core/src/commands/init/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ clerk init --framework next
clerk init --prompt
clerk init -y
clerk init --yes
clerk init --no-skills
```

## Options
Expand All@@ -19,6 +20,7 @@ clerk init --yes
| `--framework <name>` | Framework to set up (skips auto-detection). Valid values: `next`, `astro`, `nuxt`, `tanstack-start`, `react-router`, `vue`, `expo`, `react`, `express`, `fastify` |
| `--prompt` | Output a prompt for an AI agent to integrate Clerk, then exit |
| `-y, --yes` | Skip confirmation prompts |
| `--no-skills` | Skip the optional agent skills install prompt at the end of init |

## Agent Mode

Expand DownExpand Up@@ -46,6 +48,7 @@ When running in agent mode (`--mode agent` or non-TTY), outputs a framework-spec
14. Prints a summary of created, modified, and skipped files with recommendations
15. **Authenticated mode**: pulls development instance API keys via `clerk env pull`
16. **Keyless mode**: prints instructions for keyless development and how to connect a Clerk account later
17. Optionally installs framework-specific Clerk agent skills via `npx skills add` (see [Agent skills install](#agent-skills-install))

## Framework Detection

Expand DownExpand Up@@ -148,6 +151,30 @@ Nuxt's module system auto-configures middleware and auto-imports components.
| MODIFY | `src/router/index.ts` | Add sign-in and sign-up routes (if router exists) |
| MODIFY | `.env` | Add sign-in/sign-up route env vars (VITE\_ prefix) |

## Agent skills install

After scaffolding (and after env keys are pulled or keyless instructions are printed), `clerk init` offers to install Clerk's framework-specific agent skills from [`clerk/skills`](https://github.com/clerk/skills) via `npx skills add`. This step is optional and non-fatal: if `npx` is missing or the install command exits non-zero, init prints a yellow warning with the manual install command and still exits successfully.

- **Human mode**: prompts `Install agent skills? (...)` defaulting to yes. Pass `--no-skills` to suppress the prompt entirely, or `-y/--yes` to accept it without confirmation.
- **Agent mode / `--prompt`**: `clerk init` exits early before the skills step runs (see the `if (options.prompt || isAgent()) { ... return }` branch in [`index.ts`](./index.ts)), so nothing is installed. Agent users should run `npx skills add clerk/skills` manually, or have their agent do it.

The base skills `clerk` and `clerk-setup` are always included. The detected framework dependency adds a matching skill:

| Framework dep | Added skill |
| ----------------------- | ----------------------------- |
| `next` | `clerk-nextjs-patterns` |
| `react` | `clerk-react-patterns` |
| `react-router` | `clerk-react-router-patterns` |
| `vue` | `clerk-vue-patterns` |
| `nuxt` | `clerk-nuxt-patterns` |
| `astro` | `clerk-astro-patterns` |
| `@tanstack/react-start` | `clerk-tanstack-patterns` |
| `expo` | `clerk-expo-patterns` |
| `express` | `clerk-backend-api` |
| `fastify` | `clerk-backend-api` |

Implementation lives in [`skills.ts`](./skills.ts). Note that the E2E fixture setup runs `clerk init --yes --no-skills` because the skill templates reference framework-generated types (e.g. React Router's `./+types/root`) that don't exist outside a real app directory and would break the fixture's `tsc` step.

## API Endpoints

See [auth/README.md](../auth/README.md), [link/README.md](../link/README.md), and [env/README.md](../env/README.md) for the API endpoints used by each step.
2 changes: 2 additions & 0 deletions packages/cli-core/src/commands/init/index.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import * as previewMod from "./preview.ts";
import * as formatMod from "./format.ts";
import * as scanMod from "./scan.ts";
import * as heuristics from "./heuristics.ts";
import * as skillsMod from "./skills.ts";
import { init } from "./index.ts";

describe("init command", () => {
Expand DownExpand Up@@ -45,6 +46,7 @@ describe("init command", () => {
spyOn(heuristics, "writePlan").mockResolvedValue([]),
spyOn(heuristics, "checkGitDirty").mockResolvedValue(false),
spyOn(heuristics, "printOutro").mockReturnValue(undefined),
spyOn(skillsMod, "installSkills").mockResolvedValue(undefined),
spyOn(linkMod, "link").mockResolvedValue(undefined),
spyOn(pullMod, "pull").mockResolvedValue(undefined),
];
Expand Down
28 changes: 21 additions & 7 deletions packages/cli-core/src/commands/init/skills.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,13 +72,27 @@ export async function installSkills(
const interactive = isHuman() && !skipPrompt;
const args = buildSkillsArgs(skills, interactive);

const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
const exitCode = await proc.exited;
// Skills are optional — soft-fail with a warning rather than tearing down
// a successful scaffold. Bun.spawn can throw synchronously when the binary
// is missing (e.g. `npx` not on PATH on a minimal CI image), so the
// try/catch is needed in addition to the exit code check below.
let exitCode: number;
try {
const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
exitCode = await proc.exited;
} catch {
console.log(
yellow(
`\nCould not run \`npx skills add\`. You can install manually later: npx skills add ${SKILLS_SOURCE}`,
),
);
return;
}

if (exitCode !== 0) {
console.log(
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,11 +51,13 @@ clerk init
--framework <name> Framework to set up (skips auto-detection)
--prompt Output a prompt for an AI agent to integrate Clerk
--yes Skip confirmation prompts
--no-skills Skip the optional agent skills install prompt
Examples:
$ clerk init Auto-detect framework and set up Clerk
$ clerk init --framework next Set up for Next.js (skips detection)
$ clerk init --prompt Output a setup prompt for an AI agent
$ clerk init -y Skip all confirmation prompts
$ clerk init --no-skills Skip the agent skills install prompt

clerk auth login Log in via browser (OAuth)
clerk auth logout Remove stored credentials
Expand Down
27 changes: 27 additions & 0 deletions packages/cli-core/src/commands/init/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ clerk init --framework next
clerk init --prompt
clerk init -y
clerk init --yes
clerk init --no-skills
```

## Options
Expand All@@ -19,6 +20,7 @@ clerk init --yes
| `--framework <name>` | Framework to set up (skips auto-detection). Valid values: `next`, `astro`, `nuxt`, `tanstack-start`, `react-router`, `vue`, `expo`, `react`, `express`, `fastify` |
| `--prompt` | Output a prompt for an AI agent to integrate Clerk, then exit |
| `-y, --yes` | Skip confirmation prompts |
| `--no-skills` | Skip the optional agent skills install prompt at the end of init |

## Agent Mode

Expand DownExpand Up@@ -46,6 +48,7 @@ When running in agent mode (`--mode agent` or non-TTY), outputs a framework-spec
14. Prints a summary of created, modified, and skipped files with recommendations
15. **Authenticated mode**: pulls development instance API keys via `clerk env pull`
16. **Keyless mode**: prints instructions for keyless development and how to connect a Clerk account later
17. Optionally installs framework-specific Clerk agent skills via `npx skills add` (see [Agent skills install](#agent-skills-install))

## Framework Detection

Expand DownExpand Up@@ -148,6 +151,30 @@ Nuxt's module system auto-configures middleware and auto-imports components.
| MODIFY | `src/router/index.ts` | Add sign-in and sign-up routes (if router exists) |
| MODIFY | `.env` | Add sign-in/sign-up route env vars (VITE\_ prefix) |

## Agent skills install

After scaffolding (and after env keys are pulled or keyless instructions are printed), `clerk init` offers to install Clerk's framework-specific agent skills from [`clerk/skills`](https://github.com/clerk/skills) via `npx skills add`. This step is optional and non-fatal: if `npx` is missing or the install command exits non-zero, init prints a yellow warning with the manual install command and still exits successfully.

- **Human mode**: prompts `Install agent skills? (...)` defaulting to yes. Pass `--no-skills` to suppress the prompt entirely, or `-y/--yes` to accept it without confirmation.
- **Agent mode / `--prompt`**: `clerk init` exits early before the skills step runs (see the `if (options.prompt || isAgent()) { ... return }` branch in [`index.ts`](./index.ts)), so nothing is installed. Agent users should run `npx skills add clerk/skills` manually, or have their agent do it.

The base skills `clerk` and `clerk-setup` are always included. The detected framework dependency adds a matching skill:

| Framework dep | Added skill |
| ----------------------- | ----------------------------- |
| `next` | `clerk-nextjs-patterns` |
| `react` | `clerk-react-patterns` |
| `react-router` | `clerk-react-router-patterns` |
| `vue` | `clerk-vue-patterns` |
| `nuxt` | `clerk-nuxt-patterns` |
| `astro` | `clerk-astro-patterns` |
| `@tanstack/react-start` | `clerk-tanstack-patterns` |
| `expo` | `clerk-expo-patterns` |
| `express` | `clerk-backend-api` |
| `fastify` | `clerk-backend-api` |

Implementation lives in [`skills.ts`](./skills.ts). Note that the E2E fixture setup runs `clerk init --yes --no-skills` because the skill templates reference framework-generated types (e.g. React Router's `./+types/root`) that don't exist outside a real app directory and would break the fixture's `tsc` step.

## API Endpoints

See [auth/README.md](../auth/README.md), [link/README.md](../link/README.md), and [env/README.md](../env/README.md) for the API endpoints used by each step.
2 changes: 2 additions & 0 deletions packages/cli-core/src/commands/init/index.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import * as previewMod from "./preview.ts";
import * as formatMod from "./format.ts";
import * as scanMod from "./scan.ts";
import * as heuristics from "./heuristics.ts";
import * as skillsMod from "./skills.ts";
import { init } from "./index.ts";

describe("init command", () => {
Expand DownExpand Up@@ -45,6 +46,7 @@ describe("init command", () => {
spyOn(heuristics, "writePlan").mockResolvedValue([]),
spyOn(heuristics, "checkGitDirty").mockResolvedValue(false),
spyOn(heuristics, "printOutro").mockReturnValue(undefined),
spyOn(skillsMod, "installSkills").mockResolvedValue(undefined),
spyOn(linkMod, "link").mockResolvedValue(undefined),
spyOn(pullMod, "pull").mockResolvedValue(undefined),
];
Expand Down
28 changes: 21 additions & 7 deletions packages/cli-core/src/commands/init/skills.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,13 +72,27 @@ export async function installSkills(
const interactive = isHuman() && !skipPrompt;
const args = buildSkillsArgs(skills, interactive);

const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
const exitCode = await proc.exited;
// Skills are optional — soft-fail with a warning rather than tearing down
// a successful scaffold. Bun.spawn can throw synchronously when the binary
// is missing (e.g. `npx` not on PATH on a minimal CI image), so the
// try/catch is needed in addition to the exit code check below.
let exitCode: number;
try {
const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
exitCode = await proc.exited;
} catch {
console.log(
yellow(
`\nCould not run \`npx skills add\`. You can install manually later: npx skills add ${SKILLS_SOURCE}`,
),
);
return;
}

if (exitCode !== 0) {
console.log(
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,11 +51,13 @@ clerk init
--framework <name> Framework to set up (skips auto-detection)
--prompt Output a prompt for an AI agent to integrate Clerk
--yes Skip confirmation prompts
--no-skills Skip the optional agent skills install prompt
Examples:
$ clerk init Auto-detect framework and set up Clerk
$ clerk init --framework next Set up for Next.js (skips detection)
$ clerk init --prompt Output a setup prompt for an AI agent
$ clerk init -y Skip all confirmation prompts
$ clerk init --no-skills Skip the agent skills install prompt

clerk auth login Log in via browser (OAuth)
clerk auth logout Remove stored credentials
Expand Down
27 changes: 27 additions & 0 deletions packages/cli-core/src/commands/init/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ clerk init --framework next
clerk init --prompt
clerk init -y
clerk init --yes
clerk init --no-skills
```

## Options
Expand All@@ -19,6 +20,7 @@ clerk init --yes
| `--framework <name>` | Framework to set up (skips auto-detection). Valid values: `next`, `astro`, `nuxt`, `tanstack-start`, `react-router`, `vue`, `expo`, `react`, `express`, `fastify` |
| `--prompt` | Output a prompt for an AI agent to integrate Clerk, then exit |
| `-y, --yes` | Skip confirmation prompts |
| `--no-skills` | Skip the optional agent skills install prompt at the end of init |

## Agent Mode

Expand DownExpand Up@@ -46,6 +48,7 @@ When running in agent mode (`--mode agent` or non-TTY), outputs a framework-spec
14. Prints a summary of created, modified, and skipped files with recommendations
15. **Authenticated mode**: pulls development instance API keys via `clerk env pull`
16. **Keyless mode**: prints instructions for keyless development and how to connect a Clerk account later
17. Optionally installs framework-specific Clerk agent skills via `npx skills add` (see [Agent skills install](#agent-skills-install))

## Framework Detection

Expand DownExpand Up@@ -148,6 +151,30 @@ Nuxt's module system auto-configures middleware and auto-imports components.
| MODIFY | `src/router/index.ts` | Add sign-in and sign-up routes (if router exists) |
| MODIFY | `.env` | Add sign-in/sign-up route env vars (VITE\_ prefix) |

## Agent skills install

After scaffolding (and after env keys are pulled or keyless instructions are printed), `clerk init` offers to install Clerk's framework-specific agent skills from [`clerk/skills`](https://github.com/clerk/skills) via `npx skills add`. This step is optional and non-fatal: if `npx` is missing or the install command exits non-zero, init prints a yellow warning with the manual install command and still exits successfully.

- **Human mode**: prompts `Install agent skills? (...)` defaulting to yes. Pass `--no-skills` to suppress the prompt entirely, or `-y/--yes` to accept it without confirmation.
- **Agent mode / `--prompt`**: `clerk init` exits early before the skills step runs (see the `if (options.prompt || isAgent()) { ... return }` branch in [`index.ts`](./index.ts)), so nothing is installed. Agent users should run `npx skills add clerk/skills` manually, or have their agent do it.

The base skills `clerk` and `clerk-setup` are always included. The detected framework dependency adds a matching skill:

| Framework dep | Added skill |
| ----------------------- | ----------------------------- |
| `next` | `clerk-nextjs-patterns` |
| `react` | `clerk-react-patterns` |
| `react-router` | `clerk-react-router-patterns` |
| `vue` | `clerk-vue-patterns` |
| `nuxt` | `clerk-nuxt-patterns` |
| `astro` | `clerk-astro-patterns` |
| `@tanstack/react-start` | `clerk-tanstack-patterns` |
| `expo` | `clerk-expo-patterns` |
| `express` | `clerk-backend-api` |
| `fastify` | `clerk-backend-api` |

Implementation lives in [`skills.ts`](./skills.ts). Note that the E2E fixture setup runs `clerk init --yes --no-skills` because the skill templates reference framework-generated types (e.g. React Router's `./+types/root`) that don't exist outside a real app directory and would break the fixture's `tsc` step.

## API Endpoints

See [auth/README.md](../auth/README.md), [link/README.md](../link/README.md), and [env/README.md](../env/README.md) for the API endpoints used by each step.
2 changes: 2 additions & 0 deletions packages/cli-core/src/commands/init/index.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import * as previewMod from "./preview.ts";
import * as formatMod from "./format.ts";
import * as scanMod from "./scan.ts";
import * as heuristics from "./heuristics.ts";
import * as skillsMod from "./skills.ts";
import { init } from "./index.ts";

describe("init command", () => {
Expand DownExpand Up@@ -45,6 +46,7 @@ describe("init command", () => {
spyOn(heuristics, "writePlan").mockResolvedValue([]),
spyOn(heuristics, "checkGitDirty").mockResolvedValue(false),
spyOn(heuristics, "printOutro").mockReturnValue(undefined),
spyOn(skillsMod, "installSkills").mockResolvedValue(undefined),
spyOn(linkMod, "link").mockResolvedValue(undefined),
spyOn(pullMod, "pull").mockResolvedValue(undefined),
];
Expand Down
28 changes: 21 additions & 7 deletions packages/cli-core/src/commands/init/skills.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -72,13 +72,27 @@ export async function installSkills(
const interactive = isHuman() && !skipPrompt;
const args = buildSkillsArgs(skills, interactive);

const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
const exitCode = await proc.exited;
// Skills are optional — soft-fail with a warning rather than tearing down
// a successful scaffold. Bun.spawn can throw synchronously when the binary
// is missing (e.g. `npx` not on PATH on a minimal CI image), so the
// try/catch is needed in addition to the exit code check below.
let exitCode: number;
try {
const proc = Bun.spawn(args, {
cwd,
stdin: "inherit",
stdout: "inherit",
stderr: "inherit",
});
exitCode = await proc.exited;
} catch {
console.log(
yellow(
`\nCould not run \`npx skills add\`. You can install manually later: npx skills add ${SKILLS_SOURCE}`,
),
);
return;
}

if (exitCode !== 0) {
console.log(
Expand Down
Loading