diff --git a/CHANGELOG.md b/CHANGELOG.md
index 67f1cf48bb..c21e624327 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,37 +2,52 @@
---
-## 1/23/26
+## 5/22/26
-### Payments
-Introduced a redesigned payments onboarding flow
-
+- Faster ClickHouse analytics for project metrics and previews.
+- Smoother cross-domain auth handoffs and hosted-domain trust.
+- Sharper Auth Methods and Users dashboard tables.
+
-## 1/21/26
+## 5/15/26
-### Payments
-- Payments page updated with new UI changes
-
-- Added a new Payments Settings page with an option to temporarily disable all payments
-
-- Subscription renewal emails are now sent automatically to users
-- Past payment invoices are now visible on the Account Settings page
-
+- Redesigned Team Management tables with cleaner action states.
+- New project transfer, session replay, and team payments screens.
+- Unified AI chat experience on assistant-ui threads.
+
-### Documentation
-- Updated JWT documentation to include `isRestricted` and `restrictedReason`
+## 5/8/26
-## 1/19/26
-- Updated package dependencies to their newest versions.
+- New TanStack Start SDK integration with refreshed OpenAPI schemas.
+- Weekly active users now appear on Project Overview.
+- Cleaner Project Permissions with upgraded data grids.
+
-## 12/19/25
-- Introduces new changelog and deprecates all older changelogs.
-- Date versioning for public view.
+## 5/1/26
+
+- Shareable Session Replay IDs across dashboard, backend, and SDKs.
+- Sleeker Data Vault and overview data-grid layouts.
+- Emulator updates can now auto-install dependencies.
+
+
+## 4/24/26
+
+- Redesigned Email Server settings and managed-domain setup.
+- Faster local emulator startup with RAM snapshots.
+- Live secret rotation plus a simpler sign-up rules tester.
+
+
+## 4/17/26
+
+- Redesigned Overview and onboarding experience.
+- Crisper dashboard sidebar styling and category navigation.
+- New Payments product setup flow.
+
---
-> **Note:** All older changelogs are deprecated and have been removed. The source of true is this single changelog file.
->
+> **Note:** All older changelogs are deprecated and have been removed. The source of truth is this single changelog file.
+>
> Going forward, all changes should be documented in this file only.
---
diff --git a/apps/dashboard/public/assets/changelog-auth-methods.png b/apps/dashboard/public/assets/changelog-auth-methods.png
new file mode 100644
index 0000000000..90670bf6f7
Binary files /dev/null and b/apps/dashboard/public/assets/changelog-auth-methods.png differ
diff --git a/apps/dashboard/public/assets/changelog-data-vault.png b/apps/dashboard/public/assets/changelog-data-vault.png
new file mode 100644
index 0000000000..42e0e35f7c
Binary files /dev/null and b/apps/dashboard/public/assets/changelog-data-vault.png differ
diff --git a/apps/dashboard/public/assets/changelog-email-server.png b/apps/dashboard/public/assets/changelog-email-server.png
new file mode 100644
index 0000000000..48523938ac
Binary files /dev/null and b/apps/dashboard/public/assets/changelog-email-server.png differ
diff --git a/apps/dashboard/public/assets/changelog-payments-products.png b/apps/dashboard/public/assets/changelog-payments-products.png
new file mode 100644
index 0000000000..74f44d5273
Binary files /dev/null and b/apps/dashboard/public/assets/changelog-payments-products.png differ
diff --git a/apps/dashboard/public/assets/changelog-rbac.png b/apps/dashboard/public/assets/changelog-rbac.png
new file mode 100644
index 0000000000..dd3e2c81bf
Binary files /dev/null and b/apps/dashboard/public/assets/changelog-rbac.png differ
diff --git a/apps/dashboard/public/assets/changelog-teams.png b/apps/dashboard/public/assets/changelog-teams.png
new file mode 100644
index 0000000000..2e80f52f40
Binary files /dev/null and b/apps/dashboard/public/assets/changelog-teams.png differ
diff --git a/docs-mintlify/guides/getting-started/setup.mdx b/docs-mintlify/guides/getting-started/setup.mdx
index 4d7aed61ee..a66d5b14e5 100644
--- a/docs-mintlify/guides/getting-started/setup.mdx
+++ b/docs-mintlify/guides/getting-started/setup.mdx
@@ -6,7 +6,7 @@ sidebarTitle: Setup
{/* This file is auto-generated by scripts/generate-setup-prompt-docs.ts. Do not edit it manually; edit packages/stack-shared/src/ai/prompts.ts instead. */}
-export const generatedSetupPromptText = "# Setting up Stack Auth\n\nThis prompt explains how to set up Stack Auth in your project.\n\nTo use it, you can use the sections below to set up Stack Auth in the project. For example, if you are setting up a Svelte project, you would follow the SDK setup instructions for a frontend JS project.\n\n## SDK Setup Instructions\n\nFollow these instructions in order to set up and get started with the Stack Auth SDK in various languages.\n\nNot all steps are applicable to every type of application; for example, React apps have some extra steps that are not needed with other frameworks.\n\nThe frameworks and languages with explicit SDK support are:\n\n- Next.js\n- React\n- TanStack Start\n- Other JS & TS (both frontend and backend)\n\n\n \n Stack Auth has SDKs for various languages, frameworks, and libraries. Use the most specific package each, so, for example, even though a Next.js project uses both Next.js and React, use the Next.js package. If a programming language is not supported entirely, you may have to use the REST API to interface with Stack Auth.\n \n #### JavaScript & TypeScript\n \n For JS & TS, the following packages are available:\n \n - Next.js: `@stackframe/stack`\n - React: `@stackframe/react`\n - TanStack Start: `@stackframe/tanstack-start`\n - Other & vanilla JS: `@stackframe/js`\n \n You can install the correct JavaScript Stack Auth SDK into your project by running the following command:\n\n ```sh\n npm i \n # or: pnpm i \n # or: yarn add \n # or: bun add \n ```\n \n \n \n Next, let us create the Stack App object for your project. This is the most important object in a Stack Auth project.\n\n In a frontend where you cannot keep a secret key safe, you would use the `StackClientApp` constructor:\n \n ```ts src/stack/client.ts\n import { StackClientApp } from \"\";\n \n export const stackClientApp = new StackClientApp({\n tokenStore: \"cookie\", // \"nextjs-cookie\" for Next.js, \"cookie\" for other web frontends, null for backend environments\n urls: {\n default: {\n type: \"hosted\",\n }\n },\n });\n ```\n\n In a backend where you can keep a secret key safe, you can use the `StackServerApp`, which provides access to more sensitive APIs compared to `StackClientApp`:\n \n ```ts src/stack/server.ts\n import { StackServerApp } from \"\";\n \n export const stackServerApp = new StackServerApp({\n tokenStore: null,\n urls: {\n default: {\n type: \"hosted\",\n }\n },\n });\n ```\n \n In frameworks that are both front- and backend, like Next.js, you can also create a `StackServerApp` from a `StackClientApp` object:\n \n ```ts src/stack/server.ts\n import { StackServerApp } from \"\";\n import { stackClientApp } from \"./client\";\n \n export const stackServerApp = new StackServerApp({\n inheritsFrom: stackClientApp,\n });\n ```\n \n Note that the secret server key should **never** be exposed to the client, as it can be used to read and write everything in your Stack Auth project. In web frontends or bundled applications, you should therefore always only ever create a `StackClientApp` object.\n \n\n \n It's now time to connect your code to a Stack Auth project.\n\n You can either run Stack Auth's dev environment locally, or connect to a production project hosted in the cloud.\n\n If you already use Stack Auth for your product, we recommend you re-use the same project to share your configuration between the two.\n\n \n \n First, create a `stack.config.ts` configuration file in the root directory of the workspace (or anywhere else):\n\n ```ts stack.config.ts\n import type { StackConfig } from \"\";\n\n // default: show-onboarding, which shows the onboarding flow for this project when Stack Auth starts\n export const config: StackConfig = \"show-onboarding\";\n ```\n\n To run your application with Stack Auth, you can then start the dev environment and set environment variables expected by your application. Stack Auth's CLI has a `dev` command does both of these, so let's install it as a dev dependency and wrap your existing `dev` script in your package.json:\n\n ```sh\n npm i -D @stackframe/stack-cli\n # or: pnpm i -D @stackframe/stack-cli\n # or: yarn add -D @stackframe/stack-cli\n # or: bun add --dev @stackframe/stack-cli\n ```\n\n ```json package.json\n {\n // ...\n \"scripts\": {\n // ...\n \"dev\": \"stack dev --config-file ./stack.config.ts -- npm run dev:without-stack-auth\",\n \"dev:without-stack-auth\": \"\"\n }\n }\n ```\n \n\n \n Note: If you're an AI agent, and you don't already have the information you need from the Cloud project, you may have to ask the user for help on this step. You can either ask them to provide the environment variables, or just leave them empty for now and ask the user to complete them at the end.\n\n If you'd rather run your development environment on our infrastructure, or you already have an existing product, you can also connect a cloud project.\n\n This process is slightly different depending on whether you're setting up a frontend or a backend (whether your app can keep a secret key safe or not).\n\n #### Frontend\n\n Go to your project's dashboard on [app.stack-auth.com](https://app.stack-auth.com) and get the project ID. You can find it in the URL after the `/projects/` part. Copy-paste it into your `.env.local` file (or wherever your environment variables are stored):\n\n Some projects have the `requirePublishableClientKey` config option enabled. In that case, a publishable client key will also be necessary. However, this is extremely uncommon; for most projects this is not true, so don't ask the user for one unless you have confirmation that the publishable client key is required. If it's not required, the project ID is the only environment variable required to use Stack Auth on a client.\n \n ```.env .env.local\n STACK_PROJECT_ID=\n ```\n\n Alternatively, you can also just set the project ID in the `stack/client.ts` file:\n\n ```ts src/stack/client.ts\n export const stackClientApp = new StackClientApp({\n // ...\n projectId: \"your-project-id\",\n });\n ```\n\n\n #### Backend (or both frontend and backend)\n\n First, navigate to the [Project Keys](https://app.stack-auth.com/projects/-selector-/project-keys) page in the Stack Auth dashboard and generate a new set of keys.\n\n Then, copy-paste them into your `.env.local` file (or wherever your environment variables are stored):\n\n If the `requirePublishableClientKey` config option is enabled as described above, a publishable client key will also be necessary. Otherwise, these two are the only environment variables required to use Stack Auth on a server.\n \n ```.env .env.local\n STACK_PROJECT_ID=\n STACK_SECRET_SERVER_KEY=\n ```\n\n They'll automatically be picked up by the `StackServerApp` constructor.\n \n \n \n\n and \">\n In React frameworks, Stack Auth provides `StackProvider` and `StackTheme` components that should wrap your entire app at the root level.\n \n For example, if you have an `App.tsx` file, update it as follows:\n \n ```tsx src/App.tsx\n import { StackProvider, StackTheme } from \"\";\n import { stackClientApp } from \"./stack/client\";\n \n export default function App() {\n return (\n \n \n {/* your app content */}\n \n \n );\n }\n ```\n \n For Next.js specifically: You can do this in the `layout.tsx` file in the `app` directory:\n \n ```tsx src/app/layout.tsx\n import { Suspense } from \"react\";\n import { StackProvider, StackTheme } from \"\";\n import { stackServerApp } from \"@/stack/server\";\n \n export default function RootLayout({ children }: { children: React.ReactNode }) {\n return (\n \n \n {children}\n \n \n );\n }\n ```\n \n For TanStack Start specifically: TanStack Start uses file-based routes. The provider goes inside the root route's `component` (the inner React tree), while the document shell stays in `shellComponent`. Update `src/routes/__root.tsx`:\n \n ```tsx src/routes/__root.tsx\n import { StackProvider, StackTheme } from \"@stackframe/tanstack-start\";\n import { createRootRoute, HeadContent, Outlet, Scripts } from \"@tanstack/react-router\";\n import type { ReactNode } from \"react\";\n import { stackClientApp } from \"../stack/client\";\n \n export const Route = createRootRoute({\n shellComponent: RootDocument,\n component: RootComponent,\n });\n \n function RootDocument({ children }: { children: ReactNode }) {\n return (\n \n \n \n \n \n {children}\n \n \n \n );\n }\n \n function RootComponent() {\n return (\n \n \n \n \n \n );\n }\n ```\n \n Do not edit `src/routeTree.gen.ts` — it is regenerated automatically by the TanStack Start router from the files under `src/routes/`.\n \n \n \n Stack Auth also provides additional `useXyz` React hooks for `getXyz`/`listXyz` functions. For example, `useUser` is like `getUser`, but as a suspending React hook.\n \n To support the suspension, you need to add a suspense boundary around your app.\n \n The easiest way to do this is to just wrap your entire app in a `Suspense` component:\n \n ```tsx src/App.tsx\n import { Suspense } from \"react\";\n import { StackProvider, StackTheme } from \"\";\n import { stackClientApp } from \"./stack/client\";\n \n export default function App() {\n return (\n Loading...}>\n \n \n {/* your app content */}\n \n \n \n );\n }\n ```\n \n In Next.js, this can be easily done by adding a `loading.tsx` file in the `app` directory:\n \n ```tsx src/app/loading.tsx\n export default function Loading() {\n return
Loading...
;\n }\n ```\n \n In TanStack Start: wrap the `` in your root route with a `Suspense` boundary so the document shell can stream while child routes wait on Stack Auth. Update `RootComponent` in `src/routes/__root.tsx`:\n \n ```tsx src/routes/__root.tsx\n import { Suspense } from \"react\";\n // ...other imports...\n \n function RootComponent() {\n return (\n \n \n Loading...}>\n \n \n \n \n );\n }\n ```\n \n Note: If you are an AI agent, make sure to make the loading indicator visually appealing and match the design of your app, instead of the example that just says \"Loading...\".\n \n \n \n Stack Auth's auth flows (sign-in, sign-up, OAuth callbacks, password reset, etc.) are rendered by a single `StackHandler` component mounted at `/handler/*`. In TanStack Start, expose it as a splat file route at `src/routes/handler/$.tsx`:\n \n ```tsx src/routes/handler/$.tsx\n import { StackHandler } from \"@stackframe/tanstack-start\";\n import { createFileRoute, useLocation } from \"@tanstack/react-router\";\n \n export const Route = createFileRoute(\"/handler/$\")({\n ssr: false,\n component: HandlerPage,\n });\n \n function HandlerPage() {\n const { pathname } = useLocation();\n return ;\n }\n ```\n \n Two TanStack-specific notes:\n \n - The route is opted out of SSR with `ssr: false`. The handler runs browser-only auth flows (cookies, redirects, popups), so rendering it on the server provides no benefit and can fight with hydration. Other routes can opt into or out of SSR per-route the same way.\n - Stack Auth resolves the current user during SSR by reading TanStack Start's request cookies through `@stackframe/tanstack-start`'s server context. No extra wiring is required — `useUser()` \"just works\" on both server and client routes as long as `tokenStore: \"cookie\"` is set on `StackClientApp`.\n \n\n \n You are now ready to use the Stack Auth SDK. If you have any frontends calling your backend endpoints, you may want to pass along the Stack Auth tokens in a header such that you can access the same user object on your backend.\n \n The most ergonomic way to do this is to pass the result of `stackClientApp.getAuthorizationHeader()` as the `Authorization` header into your backend endpoints when the user is signed in:\n \n ```ts\n // NOTE: This is your frontend's code\n const authorizationHeader = await stackClientApp.getAuthorizationHeader();\n const response = await fetch(\"/my-backend-endpoint\", {\n headers: {\n ...(authorizationHeader ? { Authorization: authorizationHeader } : {}),\n },\n });\n // ...\n ```\n \n In most backend frameworks you can then access the user object by passing the request object as a `tokenStore` of the functions that access the user object:\n \n ```ts\n // NOTE: This is your backend's code\n const user = await stackServerApp.getUser({ tokenStore: request });\n return new Response(\"Hello, \" + user.displayName, { headers: { \"Cache-Control\": \"private, no-store\" } });\n ```\n \n This will work as long as `request` is an object that follows the shape `{ headers: Record | { get: (name: string) => string | null } }`.\n \n \n Make sure that HTTP caching is disabled with `Cache-Control: private, no-store` for authenticated backend endpoints.\n \n \n If you cannot use `getAuthorizationHeader()`, for example because you are using a protocol other than HTTP, you can use `getAuthJson()` instead:\n \n ```ts\n // Frontend:\n await rpcCall(\"my-rpc-endpoint\", {\n data: {\n auth: await stackClientApp.getAuthJson(),\n },\n });\n \n // Backend:\n const user = await stackServerApp.getUser({ tokenStore: data.auth });\n return new RpcResponse(\"Hello, \" + user.displayName);\n ```\n \n\n \n\n\n## MCP Setup\n\n\n This prompt is not yet implemented.\n\n\n\n \n Install the MCP package:\n \n \n\n\n## Convex Setup\n\nFollow these instructions to integrate Stack Auth with Convex.\n\n\n \n If the project does not already use Convex, initialize a Convex + Next.js app:\n\n ```sh\n npm create convex@latest\n ```\n\n When prompted, choose **Next.js** and **No auth**. Stack Auth will provide auth.\n\n During development, run the Convex backend and the app dev server:\n\n ```sh\n npx convex dev\n npm run dev\n ```\n \n\n \n Install Stack Auth in the app. If you have not already completed the SDK setup steps above, run the setup wizard:\n\n ```sh\n npx @stackframe/stack-cli@latest init\n ```\n\n Create or select a Stack Auth project in the dashboard. Copy the Stack Auth environment variables into the app's `.env.local` file.\n\n Also add the same Stack Auth environment variables to the Convex deployment environment in the Convex dashboard.\n \n\n \n Create or update `convex/auth.config.ts`:\n\n ```ts convex/auth.config.ts\n import { getConvexProvidersConfig } from \"@stackframe/js\";\n // or: import { getConvexProvidersConfig } from \"@stackframe/react\";\n // or: import { getConvexProvidersConfig } from \"@stackframe/stack\";\n\n export default {\n providers: getConvexProvidersConfig({\n projectId: process.env.STACK_PROJECT_ID, // or process.env.NEXT_PUBLIC_STACK_PROJECT_ID\n }),\n };\n ```\n \n\n \n Update the Convex client setup so Convex receives Stack Auth tokens.\n\n In browser JavaScript:\n\n ```ts\n convexClient.setAuth(stackClientApp.getConvexClientAuth({}));\n ```\n\n In React:\n\n ```ts\n convexReactClient.setAuth(stackClientApp.getConvexClientAuth({}));\n ```\n\n For Convex HTTP clients on the server, pass a request-like token store:\n\n ```ts\n convexHttpClient.setAuth(stackClientApp.getConvexHttpClientAuth({ tokenStore: requestObject }));\n ```\n \n\n \n In Convex queries and mutations, use Stack Auth's Convex integration to read the current user.\n\n ```ts convex/myFunctions.ts\n import { query } from \"./_generated/server\";\n import { stackServerApp } from \"../src/stack/server\";\n\n export const myQuery = query({\n handler: async (ctx, args) => {\n const user = await stackServerApp.getPartialUser({ from: \"convex\", ctx });\n return user;\n },\n });\n ```\n \n\n \n\n\n## Supabase Setup\n\n\n This setup covers Supabase Row Level Security (RLS) with Stack Auth JWTs. It does not sync user data between Supabase and Stack Auth. Use Stack Auth webhooks if you need data sync.\n\n\n\n \n In the Supabase SQL editor, enable Row Level Security for your tables and write policies based on Supabase JWT claims.\n\n For example, this sample table demonstrates public rows, authenticated rows, and user-owned rows:\n\n ```sql\n CREATE TABLE data (\n id bigint PRIMARY KEY,\n text text NOT NULL,\n user_id UUID\n );\n\n INSERT INTO data (id, text, user_id) VALUES\n (1, 'Everyone can see this', NULL),\n (2, 'Only authenticated users can see this', NULL),\n (3, 'Only user with specific id can see this', NULL);\n\n ALTER TABLE data ENABLE ROW LEVEL SECURITY;\n\n CREATE POLICY \"Public read\" ON \"public\".\"data\" TO public\n USING (id = 1);\n\n CREATE POLICY \"Authenticated access\" ON \"public\".\"data\" TO authenticated\n USING (id = 2);\n\n CREATE POLICY \"User access\" ON \"public\".\"data\" TO authenticated\n USING (id = 3 AND auth.uid() = user_id);\n ```\n \n\n \n If you are starting from scratch with Next.js, you can use Supabase's template and then initialize Stack Auth:\n\n ```sh\n npx create-next-app@latest -e with-supabase stack-supabase\n cd stack-supabase\n npx @stackframe/stack-cli@latest init\n ```\n\n Add the Supabase environment variables to `.env.local`:\n\n ```.env .env.local\n NEXT_PUBLIC_SUPABASE_URL=\n NEXT_PUBLIC_SUPABASE_ANON_KEY=\n SUPABASE_JWT_SECRET=\n ```\n\n Also add the Stack Auth environment variables:\n\n ```.env .env.local\n # The project ID is the only client-exposed Stack Auth variable; in Next.js it must\n # be prefixed with NEXT_PUBLIC_. STACK_SECRET_SERVER_KEY is server-only and must\n # NEVER be prefixed or exposed to the client.\n NEXT_PUBLIC_STACK_PROJECT_ID=\n STACK_SECRET_SERVER_KEY=\n ```\n \n\n \n Create a server action that signs a Supabase JWT using the current Stack Auth user ID:\n\n ```tsx utils/actions.ts\n 'use server';\n\n import { stackServerApp } from \"@/stack/server\";\n import * as jose from \"jose\";\n\n export const getSupabaseJwt = async () => {\n const user = await stackServerApp.getUser();\n\n if (!user) {\n return null;\n }\n\n const token = await new jose.SignJWT({\n sub: user.id,\n role: \"authenticated\",\n })\n .setProtectedHeader({ alg: \"HS256\" })\n .setIssuedAt()\n .setExpirationTime(\"1h\")\n .sign(new TextEncoder().encode(process.env.SUPABASE_JWT_SECRET));\n\n return token;\n };\n ```\n \n\n \n Create a helper that passes the server-generated JWT to Supabase:\n\n ```tsx utils/supabase-client.ts\n import { createBrowserClient } from \"@supabase/ssr\";\n import { getSupabaseJwt } from \"./actions\";\n\n export const createSupabaseClient = () => {\n return createBrowserClient(\n process.env.NEXT_PUBLIC_SUPABASE_URL!,\n process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,\n { accessToken: async () => await getSupabaseJwt() || \"\" },\n );\n };\n ```\n \n\n \n Use the Supabase client from your UI. The RLS policies will decide which rows the user can read based on the Stack Auth user ID embedded in the Supabase JWT.\n\n ```tsx app/page.tsx\n 'use client';\n\n import { createSupabaseClient } from \"@/utils/supabase-client\";\n import { useStackApp, useUser } from \"@stackframe/stack\";\n import Link from \"next/link\";\n import { useEffect, useState } from \"react\";\n\n export default function Page() {\n const app = useStackApp();\n const user = useUser();\n const supabase = createSupabaseClient();\n const [data, setData] = useState(null);\n\n useEffect(() => {\n supabase.from(\"data\").select().then(({ data }) => setData(data ?? []));\n }, []);\n\n const listContent = data === null\n ?
Loading...
\n : data.length === 0\n ?
No notes found
\n : data.map((note) =>
{note.text}
);\n\n return (\n
\n {user ? (\n <>\n
You are signed in
\n
User ID: {user.id}
\n Sign Out\n \n ) : (\n Sign In\n )}\n
Supabase data
\n
{listContent}
\n
\n );\n }\n ```\n \n\n \n\n\n## CLI Setup\n\nFollow these instructions to authenticate users in a command line application with Stack Auth.\n\n\n \n Download the Stack Auth CLI authentication template and place it in your project. For Python apps, copy it as `stack_auth_cli_template.py`.\n\n Example project layout:\n\n ```text\n my-python-app/\n ├─ main.py\n └─ stack_auth_cli_template.py\n ```\n \n\n \n Import and call `prompt_cli_login`. It opens the browser, lets the user authenticate, and returns a refresh token.\n\n ```py main.py\n from stack_auth_cli_template import prompt_cli_login\n\n refresh_token = prompt_cli_login(\n app_url=\"https://your-app-url.example.com\",\n project_id=\"your-project-id-here\",\n publishable_client_key=\"your-publishable-client-key-here\",\n )\n\n if refresh_token is None:\n print(\"User cancelled the login process. Exiting\")\n exit(1)\n ```\n\n You can store the refresh token in a local file or keychain and only prompt the user again when no saved refresh token exists.\n \n\n \n Use the refresh token with Stack Auth's REST API to get an access token.\n\n ```py\n def get_access_token(refresh_token):\n access_token_response = stack_auth_request(\n \"post\",\n \"/api/v1/auth/sessions/current/refresh\",\n headers={\n \"x-stack-refresh-token\": refresh_token,\n },\n )\n\n return access_token_response[\"access_token\"]\n ```\n \n\n \n Use the access token to call the Stack Auth REST API as the logged-in user.\n\n ```py\n def get_user_object(access_token):\n return stack_auth_request(\n \"get\",\n \"/api/v1/users/me\",\n headers={\n \"x-stack-access-token\": access_token,\n },\n )\n\n user = get_user_object(get_access_token(refresh_token))\n print(\"The user is logged in as\", user[\"display_name\"] or user[\"primary_email\"])\n ```\n \n\n \n";
+export const generatedSetupPromptText = "# Setting up Stack Auth\n\nThis prompt explains how to set up Stack Auth in your project.\n\nTo use it, you can use the sections below to set up Stack Auth in the project. For example, if you are setting up a Svelte project, you would follow the SDK setup instructions for a frontend JS project.\n\n## SDK Setup Instructions\n\nFollow these instructions in order to set up and get started with the Stack Auth SDK in various languages.\n\nNot all steps are applicable to every type of application; for example, React apps have some extra steps that are not needed with other frameworks.\n\nThe frameworks and languages with explicit SDK support are:\n\n- Next.js\n- React\n- TanStack Start\n- Other JS & TS (both frontend and backend)\n\n\n \n Stack Auth has SDKs for various languages, frameworks, and libraries. Use the most specific package each, so, for example, even though a Next.js project uses both Next.js and React, use the Next.js package. If a programming language is not supported entirely, you may have to use the REST API to interface with Stack Auth.\n \n #### JavaScript & TypeScript\n \n For JS & TS, the following packages are available:\n \n - Next.js: `@stackframe/stack`\n - React: `@stackframe/react`\n - TanStack Start: `@stackframe/tanstack-start`\n - Other & vanilla JS: `@stackframe/js`\n \n You can install the correct JavaScript Stack Auth SDK into your project by running the following command:\n\n ```sh\n npm i \n # or: pnpm i \n # or: yarn add \n # or: bun add \n ```\n \n \n \n Next, let us create the Stack App object for your project. This is the most important object in a Stack Auth project.\n\n In a frontend where you cannot keep a secret key safe, you would use the `StackClientApp` constructor:\n \n ```ts src/stack/client.ts\n import { StackClientApp } from \"\";\n \n export const stackClientApp = new StackClientApp({\n tokenStore: \"cookie\", // \"nextjs-cookie\" for Next.js, \"cookie\" for other web frontends, null for backend environments\n urls: {\n default: {\n type: \"hosted\",\n }\n },\n });\n ```\n\n In a backend where you can keep a secret key safe, you can use the `StackServerApp`, which provides access to more sensitive APIs compared to `StackClientApp`:\n \n ```ts src/stack/server.ts\n import { StackServerApp } from \"\";\n \n export const stackServerApp = new StackServerApp({\n tokenStore: null,\n urls: {\n default: {\n type: \"hosted\",\n }\n },\n });\n ```\n \n In frameworks that are both front- and backend, like Next.js, you can also create a `StackServerApp` from a `StackClientApp` object:\n \n ```ts src/stack/server.ts\n import { StackServerApp } from \"\";\n import { stackClientApp } from \"./client\";\n \n export const stackServerApp = new StackServerApp({\n inheritsFrom: stackClientApp,\n });\n ```\n \n Note that the secret server key should **never** be exposed to the client, as it can be used to read and write everything in your Stack Auth project. In web frontends or bundled applications, you should therefore always only ever create a `StackClientApp` object.\n \n\n \n It's now time to connect your code to a Stack Auth project.\n\n You can either run Stack Auth's dev environment locally, or connect to a production project hosted in the cloud.\n\n If you already use Stack Auth for your product, we recommend you re-use the same project to share your configuration between the two.\n\n \n \n First, create a `stack.config.ts` configuration file in the root directory of the workspace (or anywhere else):\n\n ```ts stack.config.ts\n import type { StackConfig } from \"\";\n\n // default: show-onboarding, which shows the onboarding flow for this project when Stack Auth starts\n export const config: StackConfig = \"show-onboarding\";\n ```\n\n To run your application with Stack Auth, you can then start the dev environment and set environment variables expected by your application. Stack Auth's CLI has a `dev` command does both of these, so let's install it as a dev dependency and wrap your existing `dev` script in your package.json:\n\n ```sh\n npm i -D @stackframe/stack-cli\n # or: pnpm i -D @stackframe/stack-cli\n # or: yarn add -D @stackframe/stack-cli\n # or: bun add --dev @stackframe/stack-cli\n ```\n\n ```json package.json\n {\n // ...\n \"scripts\": {\n // ...\n \"dev\": \"stack dev --config-file ./stack.config.ts -- npm run dev:without-stack-auth\",\n \"dev:without-stack-auth\": \"\"\n }\n }\n ```\n \n\n \n Note: If you're an AI agent, and you don't already have the information you need from the Cloud project, you may have to ask the user for help on this step. You can either ask them to provide the environment variables, or just leave them empty for now and ask the user to complete them at the end.\n\n If you'd rather run your development environment on our infrastructure, or you already have an existing product, you can also connect a cloud project.\n\n This process is slightly different depending on whether you're setting up a frontend or a backend (whether your app can keep a secret key safe or not).\n\n #### Frontend\n\n Go to your project's dashboard on [app.stack-auth.com](https://app.stack-auth.com) and get the project ID. You can find it in the URL after the `/projects/` part. Copy-paste it into your `.env.local` file (or wherever your environment variables are stored):\n\n Some projects have the `requirePublishableClientKey` config option enabled. In that case, a publishable client key will also be necessary. However, this is extremely uncommon; for most projects this is not true, so don't ask the user for one unless you have confirmation that the publishable client key is required. If it's not required, the project ID is the only environment variable required to use Stack Auth on a client.\n \n ```.env .env.local\n STACK_PROJECT_ID=\n ```\n\n Alternatively, you can also just set the project ID in the `stack/client.ts` file:\n\n ```ts src/stack/client.ts\n export const stackClientApp = new StackClientApp({\n // ...\n projectId: \"your-project-id\",\n });\n ```\n\n\n #### Backend (or both frontend and backend)\n\n First, navigate to the [Project Keys](https://app.stack-auth.com/projects/-selector-/project-keys) page in the Stack Auth dashboard and generate a new set of keys.\n\n Then, copy-paste them into your `.env.local` file (or wherever your environment variables are stored):\n\n If the `requirePublishableClientKey` config option is enabled as described above, a publishable client key will also be necessary. Otherwise, these two are the only environment variables required to use Stack Auth on a server.\n \n ```.env .env.local\n STACK_PROJECT_ID=\n STACK_SECRET_SERVER_KEY=\n ```\n\n They'll automatically be picked up by the `StackServerApp` constructor.\n \n \n \n\n and \">\n In React frameworks, Stack Auth provides `StackProvider` and `StackTheme` components that should wrap your entire app at the root level.\n \n For example, if you have an `App.tsx` file, update it as follows:\n \n ```tsx src/App.tsx\n import { StackProvider, StackTheme } from \"\";\n import { stackClientApp } from \"./stack/client\";\n \n export default function App() {\n return (\n \n \n {/* your app content */}\n \n \n );\n }\n ```\n \n For Next.js specifically: You can do this in the `layout.tsx` file in the `app` directory:\n \n ```tsx src/app/layout.tsx\n import { Suspense } from \"react\";\n import { StackProvider, StackTheme } from \"\";\n import { stackServerApp } from \"@/stack/server\";\n \n export default function RootLayout({ children }: { children: React.ReactNode }) {\n return (\n \n \n {children}\n \n \n );\n }\n ```\n \n For TanStack Start specifically: TanStack Start uses file-based routes. The provider goes inside the root route's `component` (the inner React tree), while the document shell stays in `shellComponent`. Update `src/routes/__root.tsx`:\n \n ```tsx src/routes/__root.tsx\n import { StackProvider, StackTheme } from \"@stackframe/tanstack-start\";\n import { createRootRoute, HeadContent, Outlet, Scripts } from \"@tanstack/react-router\";\n import type { ReactNode } from \"react\";\n import { stackClientApp } from \"../stack/client\";\n \n export const Route = createRootRoute({\n shellComponent: RootDocument,\n component: RootComponent,\n });\n \n function RootDocument({ children }: { children: ReactNode }) {\n return (\n \n \n \n \n \n {children}\n \n \n \n );\n }\n \n function RootComponent() {\n return (\n \n \n \n \n \n );\n }\n ```\n \n Do not edit `src/routeTree.gen.ts` — it is regenerated automatically by the TanStack Start router from the files under `src/routes/`.\n \n \n \n Stack Auth also provides additional `useXyz` React hooks for `getXyz`/`listXyz` functions. For example, `useUser` is like `getUser`, but as a suspending React hook.\n \n To support the suspension, you need to add a suspense boundary around your app.\n \n The easiest way to do this is to just wrap your entire app in a `Suspense` component:\n \n ```tsx src/App.tsx\n import { Suspense } from \"react\";\n import { StackProvider, StackTheme } from \"\";\n import { stackClientApp } from \"./stack/client\";\n \n export default function App() {\n return (\n Loading...}>\n \n \n {/* your app content */}\n \n \n \n );\n }\n ```\n \n In Next.js, this can be easily done by adding a `loading.tsx` file in the `app` directory:\n \n ```tsx src/app/loading.tsx\n export default function Loading() {\n return
Loading...
;\n }\n ```\n \n In TanStack Start: wrap the `` in your root route with a `Suspense` boundary so the document shell can stream while child routes wait on Stack Auth. Update `RootComponent` in `src/routes/__root.tsx`:\n \n ```tsx src/routes/__root.tsx\n import { Suspense } from \"react\";\n // ...other imports...\n \n function RootComponent() {\n return (\n \n \n Loading...}>\n \n \n \n \n );\n }\n ```\n \n Note: If you are an AI agent, make sure to make the loading indicator visually appealing and match the design of your app, instead of the example that just says \"Loading...\".\n \n \n \n Stack Auth's auth flows (sign-in, sign-up, OAuth callbacks, password reset, etc.) are rendered by a single `StackHandler` component mounted at `/handler/*`. In TanStack Start, expose it as a splat file route at `src/routes/handler/$.tsx`:\n \n ```tsx src/routes/handler/$.tsx\n import { StackHandler } from \"@stackframe/tanstack-start\";\n import { createFileRoute, useLocation } from \"@tanstack/react-router\";\n \n export const Route = createFileRoute(\"/handler/$\")({\n ssr: false,\n component: HandlerPage,\n });\n \n function HandlerPage() {\n const { pathname } = useLocation();\n return ;\n }\n ```\n \n Two TanStack-specific notes:\n \n - The route is opted out of SSR with `ssr: false`. The handler runs browser-only auth flows (cookies, redirects, popups), so rendering it on the server provides no benefit and can fight with hydration. Other routes can opt into or out of SSR per-route the same way.\n - Stack Auth resolves the current user during SSR by reading TanStack Start's request cookies through `@stackframe/tanstack-start`'s server context. No extra wiring is required — `useUser()` \"just works\" on both server and client routes as long as `tokenStore: \"cookie\"` is set on `StackClientApp`.\n \n\n \n You are now ready to use the Stack Auth SDK. If you have any frontends calling your backend endpoints, you may want to pass along the Stack Auth tokens in a header such that you can access the same user object on your backend.\n \n The most ergonomic way to do this is to pass the result of `stackClientApp.getAuthorizationHeader()` as the `Authorization` header into your backend endpoints when the user is signed in:\n \n ```ts\n // NOTE: This is your frontend's code\n const authorizationHeader = await stackClientApp.getAuthorizationHeader();\n const response = await fetch(\"/my-backend-endpoint\", {\n headers: {\n ...(authorizationHeader ? { Authorization: authorizationHeader } : {}),\n },\n });\n // ...\n ```\n \n In most backend frameworks you can then access the user object by passing the request object as a `tokenStore` of the functions that access the user object:\n \n ```ts\n // NOTE: This is your backend's code\n const user = await stackServerApp.getUser({ tokenStore: request });\n return new Response(\"Hello, \" + user.displayName, { headers: { \"Cache-Control\": \"private, no-store\" } });\n ```\n \n This will work as long as `request` is an object that follows the shape `{ headers: Record | { get: (name: string) => string | null } }`.\n \n \n Make sure that HTTP caching is disabled with `Cache-Control: private, no-store` for authenticated backend endpoints.\n \n \n If you cannot use `getAuthorizationHeader()`, for example because you are using a protocol other than HTTP, you can use `getAuthJson()` instead:\n \n ```ts\n // Frontend:\n await rpcCall(\"my-rpc-endpoint\", {\n data: {\n auth: await stackClientApp.getAuthJson(),\n },\n });\n \n // Backend:\n const user = await stackServerApp.getUser({ tokenStore: data.auth });\n return new RpcResponse(\"Hello, \" + user.displayName);\n ```\n \n\n \n\n\n## Convex Setup\n\nFollow these instructions to integrate Stack Auth with Convex.\n\n\n \n If the project does not already use Convex, initialize a Convex + Next.js app:\n\n ```sh\n npm create convex@latest\n ```\n\n When prompted, choose **Next.js** and **No auth**. Stack Auth will provide auth.\n\n During development, run the Convex backend and the app dev server:\n\n ```sh\n npx convex dev\n npm run dev\n ```\n \n\n \n Install Stack Auth in the app. If you have not already completed the SDK setup steps above, run the setup wizard:\n\n ```sh\n npx @stackframe/stack-cli@latest init\n ```\n\n Create or select a Stack Auth project in the dashboard. Copy the Stack Auth environment variables into the app's `.env.local` file.\n\n Also add the same Stack Auth environment variables to the Convex deployment environment in the Convex dashboard.\n \n\n \n Create or update `convex/auth.config.ts`:\n\n ```ts convex/auth.config.ts\n import { getConvexProvidersConfig } from \"@stackframe/js\";\n // or: import { getConvexProvidersConfig } from \"@stackframe/react\";\n // or: import { getConvexProvidersConfig } from \"@stackframe/stack\";\n\n export default {\n providers: getConvexProvidersConfig({\n projectId: process.env.STACK_PROJECT_ID, // or process.env.NEXT_PUBLIC_STACK_PROJECT_ID\n }),\n };\n ```\n \n\n \n Update the Convex client setup so Convex receives Stack Auth tokens.\n\n In browser JavaScript:\n\n ```ts\n convexClient.setAuth(stackClientApp.getConvexClientAuth({}));\n ```\n\n In React:\n\n ```ts\n convexReactClient.setAuth(stackClientApp.getConvexClientAuth({}));\n ```\n\n For Convex HTTP clients on the server, pass a request-like token store:\n\n ```ts\n convexHttpClient.setAuth(stackClientApp.getConvexHttpClientAuth({ tokenStore: requestObject }));\n ```\n \n\n \n In Convex queries and mutations, use Stack Auth's Convex integration to read the current user.\n\n ```ts convex/myFunctions.ts\n import { query } from \"./_generated/server\";\n import { stackServerApp } from \"../src/stack/server\";\n\n export const myQuery = query({\n handler: async (ctx, args) => {\n const user = await stackServerApp.getPartialUser({ from: \"convex\", ctx });\n return user;\n },\n });\n ```\n \n\n \n\n\n## Supabase Setup\n\n\n This setup covers Supabase Row Level Security (RLS) with Stack Auth JWTs. It does not sync user data between Supabase and Stack Auth. Use Stack Auth webhooks if you need data sync.\n\n\n\n \n In the Supabase SQL editor, enable Row Level Security for your tables and write policies based on Supabase JWT claims.\n\n For example, this sample table demonstrates public rows, authenticated rows, and user-owned rows:\n\n ```sql\n CREATE TABLE data (\n id bigint PRIMARY KEY,\n text text NOT NULL,\n user_id UUID\n );\n\n INSERT INTO data (id, text, user_id) VALUES\n (1, 'Everyone can see this', NULL),\n (2, 'Only authenticated users can see this', NULL),\n (3, 'Only user with specific id can see this', NULL);\n\n ALTER TABLE data ENABLE ROW LEVEL SECURITY;\n\n CREATE POLICY \"Public read\" ON \"public\".\"data\" TO public\n USING (id = 1);\n\n CREATE POLICY \"Authenticated access\" ON \"public\".\"data\" TO authenticated\n USING (id = 2);\n\n CREATE POLICY \"User access\" ON \"public\".\"data\" TO authenticated\n USING (id = 3 AND auth.uid() = user_id);\n ```\n \n\n \n If you are starting from scratch with Next.js, you can use Supabase's template and then initialize Stack Auth:\n\n ```sh\n npx create-next-app@latest -e with-supabase stack-supabase\n cd stack-supabase\n npx @stackframe/stack-cli@latest init\n ```\n\n Add the Supabase environment variables to `.env.local`:\n\n ```.env .env.local\n NEXT_PUBLIC_SUPABASE_URL=\n NEXT_PUBLIC_SUPABASE_ANON_KEY=\n SUPABASE_JWT_SECRET=\n ```\n\n Also add the Stack Auth environment variables:\n\n ```.env .env.local\n # The project ID is the only client-exposed Stack Auth variable; in Next.js it must\n # be prefixed with NEXT_PUBLIC_. STACK_SECRET_SERVER_KEY is server-only and must\n # NEVER be prefixed or exposed to the client.\n NEXT_PUBLIC_STACK_PROJECT_ID=\n STACK_SECRET_SERVER_KEY=\n ```\n \n\n \n Create a server action that signs a Supabase JWT using the current Stack Auth user ID:\n\n ```tsx utils/actions.ts\n 'use server';\n\n import { stackServerApp } from \"@/stack/server\";\n import * as jose from \"jose\";\n\n export const getSupabaseJwt = async () => {\n const user = await stackServerApp.getUser();\n\n if (!user) {\n return null;\n }\n\n const token = await new jose.SignJWT({\n sub: user.id,\n role: \"authenticated\",\n })\n .setProtectedHeader({ alg: \"HS256\" })\n .setIssuedAt()\n .setExpirationTime(\"1h\")\n .sign(new TextEncoder().encode(process.env.SUPABASE_JWT_SECRET));\n\n return token;\n };\n ```\n \n\n \n Create a helper that passes the server-generated JWT to Supabase:\n\n ```tsx utils/supabase-client.ts\n import { createBrowserClient } from \"@supabase/ssr\";\n import { getSupabaseJwt } from \"./actions\";\n\n export const createSupabaseClient = () => {\n return createBrowserClient(\n process.env.NEXT_PUBLIC_SUPABASE_URL!,\n process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,\n { accessToken: async () => await getSupabaseJwt() || \"\" },\n );\n };\n ```\n \n\n \n Use the Supabase client from your UI. The RLS policies will decide which rows the user can read based on the Stack Auth user ID embedded in the Supabase JWT.\n\n ```tsx app/page.tsx\n 'use client';\n\n import { createSupabaseClient } from \"@/utils/supabase-client\";\n import { useStackApp, useUser } from \"@stackframe/stack\";\n import Link from \"next/link\";\n import { useEffect, useState } from \"react\";\n\n export default function Page() {\n const app = useStackApp();\n const user = useUser();\n const supabase = createSupabaseClient();\n const [data, setData] = useState(null);\n\n useEffect(() => {\n supabase.from(\"data\").select().then(({ data }) => setData(data ?? []));\n }, []);\n\n const listContent = data === null\n ?
Loading...
\n : data.length === 0\n ?
No notes found
\n : data.map((note) =>
{note.text}
);\n\n return (\n
\n {user ? (\n <>\n
You are signed in
\n
User ID: {user.id}
\n Sign Out\n \n ) : (\n Sign In\n )}\n
Supabase data
\n
{listContent}
\n
\n );\n }\n ```\n \n\n \n\n\n## CLI Setup\n\nFollow these instructions to authenticate users in a command line application with Stack Auth.\n\n\n \n Download the Stack Auth CLI authentication template and place it in your project. For Python apps, copy it as `stack_auth_cli_template.py`.\n\n Example project layout:\n\n ```text\n my-python-app/\n ├─ main.py\n └─ stack_auth_cli_template.py\n ```\n \n\n \n Import and call `prompt_cli_login`. It opens the browser, lets the user authenticate, and returns a refresh token.\n\n ```py main.py\n from stack_auth_cli_template import prompt_cli_login\n\n refresh_token = prompt_cli_login(\n app_url=\"https://your-app-url.example.com\",\n project_id=\"your-project-id-here\",\n publishable_client_key=\"your-publishable-client-key-here\",\n )\n\n if refresh_token is None:\n print(\"User cancelled the login process. Exiting\")\n exit(1)\n ```\n\n You can store the refresh token in a local file or keychain and only prompt the user again when no saved refresh token exists.\n \n\n \n Use the refresh token with Stack Auth's REST API to get an access token.\n\n ```py\n def get_access_token(refresh_token):\n access_token_response = stack_auth_request(\n \"post\",\n \"/api/v1/auth/sessions/current/refresh\",\n headers={\n \"x-stack-refresh-token\": refresh_token,\n },\n )\n\n return access_token_response[\"access_token\"]\n ```\n \n\n \n Use the access token to call the Stack Auth REST API as the logged-in user.\n\n ```py\n def get_user_object(access_token):\n return stack_auth_request(\n \"get\",\n \"/api/v1/users/me\",\n headers={\n \"x-stack-access-token\": access_token,\n },\n )\n\n user = get_user_object(get_access_token(refresh_token))\n print(\"The user is logged in as\", user[\"display_name\"] or user[\"primary_email\"])\n ```\n \n\n \n";
export const setupToolIds = ["nextjs","react","js","tanstack-start","tanstack-query","nodejs","bun","convex","supabase","cli"];
export const setupTabMetadata = [{"toolId":"nextjs","title":"Next.js"},{"toolId":"react","title":"React"},{"toolId":"js","title":"JS/TS"},{"toolId":"tanstack-start","title":"Tanstack Start"},{"toolId":"nodejs","title":"Node.js"},{"toolId":"bun","title":"Bun"},{"toolId":"convex","title":"Convex"},{"toolId":"supabase","title":"Supabase"},{"toolId":"cli","title":"CLI"}];
export const unifiedAiPromptTabTitle = "Unified AI Prompt";
diff --git a/docs-mintlify/snippets/home-prompt-island.jsx b/docs-mintlify/snippets/home-prompt-island.jsx
index 3a40f53543..2a9e6c158a 100644
--- a/docs-mintlify/snippets/home-prompt-island.jsx
+++ b/docs-mintlify/snippets/home-prompt-island.jsx
@@ -1,6 +1,6 @@
// This file is auto-generated by scripts/generate-setup-prompt-docs.ts. Do not edit it manually; edit packages/stack-shared/src/ai/prompts.ts instead.
-export const generatedSetupPromptText = "# Setting up Stack Auth\n\nThis prompt explains how to set up Stack Auth in your project.\n\nTo use it, you can use the sections below to set up Stack Auth in the project. For example, if you are setting up a Svelte project, you would follow the SDK setup instructions for a frontend JS project.\n\n## SDK Setup Instructions\n\nFollow these instructions in order to set up and get started with the Stack Auth SDK in various languages.\n\nNot all steps are applicable to every type of application; for example, React apps have some extra steps that are not needed with other frameworks.\n\nThe frameworks and languages with explicit SDK support are:\n\n- Next.js\n- React\n- TanStack Start\n- Other JS & TS (both frontend and backend)\n\n\n \n Stack Auth has SDKs for various languages, frameworks, and libraries. Use the most specific package each, so, for example, even though a Next.js project uses both Next.js and React, use the Next.js package. If a programming language is not supported entirely, you may have to use the REST API to interface with Stack Auth.\n \n #### JavaScript & TypeScript\n \n For JS & TS, the following packages are available:\n \n - Next.js: `@stackframe/stack`\n - React: `@stackframe/react`\n - TanStack Start: `@stackframe/tanstack-start`\n - Other & vanilla JS: `@stackframe/js`\n \n You can install the correct JavaScript Stack Auth SDK into your project by running the following command:\n\n ```sh\n npm i \n # or: pnpm i \n # or: yarn add \n # or: bun add \n ```\n \n \n \n Next, let us create the Stack App object for your project. This is the most important object in a Stack Auth project.\n\n In a frontend where you cannot keep a secret key safe, you would use the `StackClientApp` constructor:\n \n ```ts src/stack/client.ts\n import { StackClientApp } from \"\";\n \n export const stackClientApp = new StackClientApp({\n tokenStore: \"cookie\", // \"nextjs-cookie\" for Next.js, \"cookie\" for other web frontends, null for backend environments\n urls: {\n default: {\n type: \"hosted\",\n }\n },\n });\n ```\n\n In a backend where you can keep a secret key safe, you can use the `StackServerApp`, which provides access to more sensitive APIs compared to `StackClientApp`:\n \n ```ts src/stack/server.ts\n import { StackServerApp } from \"\";\n \n export const stackServerApp = new StackServerApp({\n tokenStore: null,\n urls: {\n default: {\n type: \"hosted\",\n }\n },\n });\n ```\n \n In frameworks that are both front- and backend, like Next.js, you can also create a `StackServerApp` from a `StackClientApp` object:\n \n ```ts src/stack/server.ts\n import { StackServerApp } from \"\";\n import { stackClientApp } from \"./client\";\n \n export const stackServerApp = new StackServerApp({\n inheritsFrom: stackClientApp,\n });\n ```\n \n Note that the secret server key should **never** be exposed to the client, as it can be used to read and write everything in your Stack Auth project. In web frontends or bundled applications, you should therefore always only ever create a `StackClientApp` object.\n \n\n \n It's now time to connect your code to a Stack Auth project.\n\n You can either run Stack Auth's dev environment locally, or connect to a production project hosted in the cloud.\n\n If you already use Stack Auth for your product, we recommend you re-use the same project to share your configuration between the two.\n\n \n \n First, create a `stack.config.ts` configuration file in the root directory of the workspace (or anywhere else):\n\n ```ts stack.config.ts\n import type { StackConfig } from \"\";\n\n // default: show-onboarding, which shows the onboarding flow for this project when Stack Auth starts\n export const config: StackConfig = \"show-onboarding\";\n ```\n\n To run your application with Stack Auth, you can then start the dev environment and set environment variables expected by your application. Stack Auth's CLI has a `dev` command does both of these, so let's install it as a dev dependency and wrap your existing `dev` script in your package.json:\n\n ```sh\n npm i -D @stackframe/stack-cli\n # or: pnpm i -D @stackframe/stack-cli\n # or: yarn add -D @stackframe/stack-cli\n # or: bun add --dev @stackframe/stack-cli\n ```\n\n ```json package.json\n {\n // ...\n \"scripts\": {\n // ...\n \"dev\": \"stack dev --config-file ./stack.config.ts -- npm run dev:without-stack-auth\",\n \"dev:without-stack-auth\": \"\"\n }\n }\n ```\n \n\n \n Note: If you're an AI agent, and you don't already have the information you need from the Cloud project, you may have to ask the user for help on this step. You can either ask them to provide the environment variables, or just leave them empty for now and ask the user to complete them at the end.\n\n If you'd rather run your development environment on our infrastructure, or you already have an existing product, you can also connect a cloud project.\n\n This process is slightly different depending on whether you're setting up a frontend or a backend (whether your app can keep a secret key safe or not).\n\n #### Frontend\n\n Go to your project's dashboard on [app.stack-auth.com](https://app.stack-auth.com) and get the project ID. You can find it in the URL after the `/projects/` part. Copy-paste it into your `.env.local` file (or wherever your environment variables are stored):\n\n Some projects have the `requirePublishableClientKey` config option enabled. In that case, a publishable client key will also be necessary. However, this is extremely uncommon; for most projects this is not true, so don't ask the user for one unless you have confirmation that the publishable client key is required. If it's not required, the project ID is the only environment variable required to use Stack Auth on a client.\n \n ```.env .env.local\n STACK_PROJECT_ID=\n ```\n\n Alternatively, you can also just set the project ID in the `stack/client.ts` file:\n\n ```ts src/stack/client.ts\n export const stackClientApp = new StackClientApp({\n // ...\n projectId: \"your-project-id\",\n });\n ```\n\n\n #### Backend (or both frontend and backend)\n\n First, navigate to the [Project Keys](https://app.stack-auth.com/projects/-selector-/project-keys) page in the Stack Auth dashboard and generate a new set of keys.\n\n Then, copy-paste them into your `.env.local` file (or wherever your environment variables are stored):\n\n If the `requirePublishableClientKey` config option is enabled as described above, a publishable client key will also be necessary. Otherwise, these two are the only environment variables required to use Stack Auth on a server.\n \n ```.env .env.local\n STACK_PROJECT_ID=\n STACK_SECRET_SERVER_KEY=\n ```\n\n They'll automatically be picked up by the `StackServerApp` constructor.\n \n \n \n\n and \">\n In React frameworks, Stack Auth provides `StackProvider` and `StackTheme` components that should wrap your entire app at the root level.\n \n For example, if you have an `App.tsx` file, update it as follows:\n \n ```tsx src/App.tsx\n import { StackProvider, StackTheme } from \"\";\n import { stackClientApp } from \"./stack/client\";\n \n export default function App() {\n return (\n \n \n {/* your app content */}\n \n \n );\n }\n ```\n \n For Next.js specifically: You can do this in the `layout.tsx` file in the `app` directory:\n \n ```tsx src/app/layout.tsx\n import { Suspense } from \"react\";\n import { StackProvider, StackTheme } from \"\";\n import { stackServerApp } from \"@/stack/server\";\n \n export default function RootLayout({ children }: { children: React.ReactNode }) {\n return (\n \n \n {children}\n \n \n );\n }\n ```\n \n For TanStack Start specifically: TanStack Start uses file-based routes. The provider goes inside the root route's `component` (the inner React tree), while the document shell stays in `shellComponent`. Update `src/routes/__root.tsx`:\n \n ```tsx src/routes/__root.tsx\n import { StackProvider, StackTheme } from \"@stackframe/tanstack-start\";\n import { createRootRoute, HeadContent, Outlet, Scripts } from \"@tanstack/react-router\";\n import type { ReactNode } from \"react\";\n import { stackClientApp } from \"../stack/client\";\n \n export const Route = createRootRoute({\n shellComponent: RootDocument,\n component: RootComponent,\n });\n \n function RootDocument({ children }: { children: ReactNode }) {\n return (\n \n \n \n \n \n {children}\n \n \n \n );\n }\n \n function RootComponent() {\n return (\n \n \n \n \n \n );\n }\n ```\n \n Do not edit `src/routeTree.gen.ts` — it is regenerated automatically by the TanStack Start router from the files under `src/routes/`.\n \n \n \n Stack Auth also provides additional `useXyz` React hooks for `getXyz`/`listXyz` functions. For example, `useUser` is like `getUser`, but as a suspending React hook.\n \n To support the suspension, you need to add a suspense boundary around your app.\n \n The easiest way to do this is to just wrap your entire app in a `Suspense` component:\n \n ```tsx src/App.tsx\n import { Suspense } from \"react\";\n import { StackProvider, StackTheme } from \"\";\n import { stackClientApp } from \"./stack/client\";\n \n export default function App() {\n return (\n Loading...}>\n \n \n {/* your app content */}\n \n \n \n );\n }\n ```\n \n In Next.js, this can be easily done by adding a `loading.tsx` file in the `app` directory:\n \n ```tsx src/app/loading.tsx\n export default function Loading() {\n return
Loading...
;\n }\n ```\n \n In TanStack Start: wrap the `` in your root route with a `Suspense` boundary so the document shell can stream while child routes wait on Stack Auth. Update `RootComponent` in `src/routes/__root.tsx`:\n \n ```tsx src/routes/__root.tsx\n import { Suspense } from \"react\";\n // ...other imports...\n \n function RootComponent() {\n return (\n \n \n Loading...}>\n \n \n \n \n );\n }\n ```\n \n Note: If you are an AI agent, make sure to make the loading indicator visually appealing and match the design of your app, instead of the example that just says \"Loading...\".\n \n \n \n Stack Auth's auth flows (sign-in, sign-up, OAuth callbacks, password reset, etc.) are rendered by a single `StackHandler` component mounted at `/handler/*`. In TanStack Start, expose it as a splat file route at `src/routes/handler/$.tsx`:\n \n ```tsx src/routes/handler/$.tsx\n import { StackHandler } from \"@stackframe/tanstack-start\";\n import { createFileRoute, useLocation } from \"@tanstack/react-router\";\n \n export const Route = createFileRoute(\"/handler/$\")({\n ssr: false,\n component: HandlerPage,\n });\n \n function HandlerPage() {\n const { pathname } = useLocation();\n return ;\n }\n ```\n \n Two TanStack-specific notes:\n \n - The route is opted out of SSR with `ssr: false`. The handler runs browser-only auth flows (cookies, redirects, popups), so rendering it on the server provides no benefit and can fight with hydration. Other routes can opt into or out of SSR per-route the same way.\n - Stack Auth resolves the current user during SSR by reading TanStack Start's request cookies through `@stackframe/tanstack-start`'s server context. No extra wiring is required — `useUser()` \"just works\" on both server and client routes as long as `tokenStore: \"cookie\"` is set on `StackClientApp`.\n \n\n \n You are now ready to use the Stack Auth SDK. If you have any frontends calling your backend endpoints, you may want to pass along the Stack Auth tokens in a header such that you can access the same user object on your backend.\n \n The most ergonomic way to do this is to pass the result of `stackClientApp.getAuthorizationHeader()` as the `Authorization` header into your backend endpoints when the user is signed in:\n \n ```ts\n // NOTE: This is your frontend's code\n const authorizationHeader = await stackClientApp.getAuthorizationHeader();\n const response = await fetch(\"/my-backend-endpoint\", {\n headers: {\n ...(authorizationHeader ? { Authorization: authorizationHeader } : {}),\n },\n });\n // ...\n ```\n \n In most backend frameworks you can then access the user object by passing the request object as a `tokenStore` of the functions that access the user object:\n \n ```ts\n // NOTE: This is your backend's code\n const user = await stackServerApp.getUser({ tokenStore: request });\n return new Response(\"Hello, \" + user.displayName, { headers: { \"Cache-Control\": \"private, no-store\" } });\n ```\n \n This will work as long as `request` is an object that follows the shape `{ headers: Record | { get: (name: string) => string | null } }`.\n \n \n Make sure that HTTP caching is disabled with `Cache-Control: private, no-store` for authenticated backend endpoints.\n \n \n If you cannot use `getAuthorizationHeader()`, for example because you are using a protocol other than HTTP, you can use `getAuthJson()` instead:\n \n ```ts\n // Frontend:\n await rpcCall(\"my-rpc-endpoint\", {\n data: {\n auth: await stackClientApp.getAuthJson(),\n },\n });\n \n // Backend:\n const user = await stackServerApp.getUser({ tokenStore: data.auth });\n return new RpcResponse(\"Hello, \" + user.displayName);\n ```\n \n\n \n\n\n## MCP Setup\n\n\n This prompt is not yet implemented.\n\n\n\n \n Install the MCP package:\n \n \n\n\n## Convex Setup\n\nFollow these instructions to integrate Stack Auth with Convex.\n\n\n \n If the project does not already use Convex, initialize a Convex + Next.js app:\n\n ```sh\n npm create convex@latest\n ```\n\n When prompted, choose **Next.js** and **No auth**. Stack Auth will provide auth.\n\n During development, run the Convex backend and the app dev server:\n\n ```sh\n npx convex dev\n npm run dev\n ```\n \n\n \n Install Stack Auth in the app. If you have not already completed the SDK setup steps above, run the setup wizard:\n\n ```sh\n npx @stackframe/stack-cli@latest init\n ```\n\n Create or select a Stack Auth project in the dashboard. Copy the Stack Auth environment variables into the app's `.env.local` file.\n\n Also add the same Stack Auth environment variables to the Convex deployment environment in the Convex dashboard.\n \n\n \n Create or update `convex/auth.config.ts`:\n\n ```ts convex/auth.config.ts\n import { getConvexProvidersConfig } from \"@stackframe/js\";\n // or: import { getConvexProvidersConfig } from \"@stackframe/react\";\n // or: import { getConvexProvidersConfig } from \"@stackframe/stack\";\n\n export default {\n providers: getConvexProvidersConfig({\n projectId: process.env.STACK_PROJECT_ID, // or process.env.NEXT_PUBLIC_STACK_PROJECT_ID\n }),\n };\n ```\n \n\n \n Update the Convex client setup so Convex receives Stack Auth tokens.\n\n In browser JavaScript:\n\n ```ts\n convexClient.setAuth(stackClientApp.getConvexClientAuth({}));\n ```\n\n In React:\n\n ```ts\n convexReactClient.setAuth(stackClientApp.getConvexClientAuth({}));\n ```\n\n For Convex HTTP clients on the server, pass a request-like token store:\n\n ```ts\n convexHttpClient.setAuth(stackClientApp.getConvexHttpClientAuth({ tokenStore: requestObject }));\n ```\n \n\n \n In Convex queries and mutations, use Stack Auth's Convex integration to read the current user.\n\n ```ts convex/myFunctions.ts\n import { query } from \"./_generated/server\";\n import { stackServerApp } from \"../src/stack/server\";\n\n export const myQuery = query({\n handler: async (ctx, args) => {\n const user = await stackServerApp.getPartialUser({ from: \"convex\", ctx });\n return user;\n },\n });\n ```\n \n\n \n\n\n## Supabase Setup\n\n\n This setup covers Supabase Row Level Security (RLS) with Stack Auth JWTs. It does not sync user data between Supabase and Stack Auth. Use Stack Auth webhooks if you need data sync.\n\n\n\n \n In the Supabase SQL editor, enable Row Level Security for your tables and write policies based on Supabase JWT claims.\n\n For example, this sample table demonstrates public rows, authenticated rows, and user-owned rows:\n\n ```sql\n CREATE TABLE data (\n id bigint PRIMARY KEY,\n text text NOT NULL,\n user_id UUID\n );\n\n INSERT INTO data (id, text, user_id) VALUES\n (1, 'Everyone can see this', NULL),\n (2, 'Only authenticated users can see this', NULL),\n (3, 'Only user with specific id can see this', NULL);\n\n ALTER TABLE data ENABLE ROW LEVEL SECURITY;\n\n CREATE POLICY \"Public read\" ON \"public\".\"data\" TO public\n USING (id = 1);\n\n CREATE POLICY \"Authenticated access\" ON \"public\".\"data\" TO authenticated\n USING (id = 2);\n\n CREATE POLICY \"User access\" ON \"public\".\"data\" TO authenticated\n USING (id = 3 AND auth.uid() = user_id);\n ```\n \n\n \n If you are starting from scratch with Next.js, you can use Supabase's template and then initialize Stack Auth:\n\n ```sh\n npx create-next-app@latest -e with-supabase stack-supabase\n cd stack-supabase\n npx @stackframe/stack-cli@latest init\n ```\n\n Add the Supabase environment variables to `.env.local`:\n\n ```.env .env.local\n NEXT_PUBLIC_SUPABASE_URL=\n NEXT_PUBLIC_SUPABASE_ANON_KEY=\n SUPABASE_JWT_SECRET=\n ```\n\n Also add the Stack Auth environment variables:\n\n ```.env .env.local\n # The project ID is the only client-exposed Stack Auth variable; in Next.js it must\n # be prefixed with NEXT_PUBLIC_. STACK_SECRET_SERVER_KEY is server-only and must\n # NEVER be prefixed or exposed to the client.\n NEXT_PUBLIC_STACK_PROJECT_ID=\n STACK_SECRET_SERVER_KEY=\n ```\n \n\n \n Create a server action that signs a Supabase JWT using the current Stack Auth user ID:\n\n ```tsx utils/actions.ts\n 'use server';\n\n import { stackServerApp } from \"@/stack/server\";\n import * as jose from \"jose\";\n\n export const getSupabaseJwt = async () => {\n const user = await stackServerApp.getUser();\n\n if (!user) {\n return null;\n }\n\n const token = await new jose.SignJWT({\n sub: user.id,\n role: \"authenticated\",\n })\n .setProtectedHeader({ alg: \"HS256\" })\n .setIssuedAt()\n .setExpirationTime(\"1h\")\n .sign(new TextEncoder().encode(process.env.SUPABASE_JWT_SECRET));\n\n return token;\n };\n ```\n \n\n \n Create a helper that passes the server-generated JWT to Supabase:\n\n ```tsx utils/supabase-client.ts\n import { createBrowserClient } from \"@supabase/ssr\";\n import { getSupabaseJwt } from \"./actions\";\n\n export const createSupabaseClient = () => {\n return createBrowserClient(\n process.env.NEXT_PUBLIC_SUPABASE_URL!,\n process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,\n { accessToken: async () => await getSupabaseJwt() || \"\" },\n );\n };\n ```\n \n\n \n Use the Supabase client from your UI. The RLS policies will decide which rows the user can read based on the Stack Auth user ID embedded in the Supabase JWT.\n\n ```tsx app/page.tsx\n 'use client';\n\n import { createSupabaseClient } from \"@/utils/supabase-client\";\n import { useStackApp, useUser } from \"@stackframe/stack\";\n import Link from \"next/link\";\n import { useEffect, useState } from \"react\";\n\n export default function Page() {\n const app = useStackApp();\n const user = useUser();\n const supabase = createSupabaseClient();\n const [data, setData] = useState(null);\n\n useEffect(() => {\n supabase.from(\"data\").select().then(({ data }) => setData(data ?? []));\n }, []);\n\n const listContent = data === null\n ?
Loading...
\n : data.length === 0\n ?
No notes found
\n : data.map((note) =>
{note.text}
);\n\n return (\n
\n {user ? (\n <>\n
You are signed in
\n
User ID: {user.id}
\n Sign Out\n \n ) : (\n Sign In\n )}\n
Supabase data
\n
{listContent}
\n
\n );\n }\n ```\n \n\n \n\n\n## CLI Setup\n\nFollow these instructions to authenticate users in a command line application with Stack Auth.\n\n\n \n Download the Stack Auth CLI authentication template and place it in your project. For Python apps, copy it as `stack_auth_cli_template.py`.\n\n Example project layout:\n\n ```text\n my-python-app/\n ├─ main.py\n └─ stack_auth_cli_template.py\n ```\n \n\n \n Import and call `prompt_cli_login`. It opens the browser, lets the user authenticate, and returns a refresh token.\n\n ```py main.py\n from stack_auth_cli_template import prompt_cli_login\n\n refresh_token = prompt_cli_login(\n app_url=\"https://your-app-url.example.com\",\n project_id=\"your-project-id-here\",\n publishable_client_key=\"your-publishable-client-key-here\",\n )\n\n if refresh_token is None:\n print(\"User cancelled the login process. Exiting\")\n exit(1)\n ```\n\n You can store the refresh token in a local file or keychain and only prompt the user again when no saved refresh token exists.\n \n\n \n Use the refresh token with Stack Auth's REST API to get an access token.\n\n ```py\n def get_access_token(refresh_token):\n access_token_response = stack_auth_request(\n \"post\",\n \"/api/v1/auth/sessions/current/refresh\",\n headers={\n \"x-stack-refresh-token\": refresh_token,\n },\n )\n\n return access_token_response[\"access_token\"]\n ```\n \n\n \n Use the access token to call the Stack Auth REST API as the logged-in user.\n\n ```py\n def get_user_object(access_token):\n return stack_auth_request(\n \"get\",\n \"/api/v1/users/me\",\n headers={\n \"x-stack-access-token\": access_token,\n },\n )\n\n user = get_user_object(get_access_token(refresh_token))\n print(\"The user is logged in as\", user[\"display_name\"] or user[\"primary_email\"])\n ```\n \n\n \n";
+export const generatedSetupPromptText = "# Setting up Stack Auth\n\nThis prompt explains how to set up Stack Auth in your project.\n\nTo use it, you can use the sections below to set up Stack Auth in the project. For example, if you are setting up a Svelte project, you would follow the SDK setup instructions for a frontend JS project.\n\n## SDK Setup Instructions\n\nFollow these instructions in order to set up and get started with the Stack Auth SDK in various languages.\n\nNot all steps are applicable to every type of application; for example, React apps have some extra steps that are not needed with other frameworks.\n\nThe frameworks and languages with explicit SDK support are:\n\n- Next.js\n- React\n- TanStack Start\n- Other JS & TS (both frontend and backend)\n\n\n \n Stack Auth has SDKs for various languages, frameworks, and libraries. Use the most specific package each, so, for example, even though a Next.js project uses both Next.js and React, use the Next.js package. If a programming language is not supported entirely, you may have to use the REST API to interface with Stack Auth.\n \n #### JavaScript & TypeScript\n \n For JS & TS, the following packages are available:\n \n - Next.js: `@stackframe/stack`\n - React: `@stackframe/react`\n - TanStack Start: `@stackframe/tanstack-start`\n - Other & vanilla JS: `@stackframe/js`\n \n You can install the correct JavaScript Stack Auth SDK into your project by running the following command:\n\n ```sh\n npm i \n # or: pnpm i \n # or: yarn add \n # or: bun add \n ```\n \n \n \n Next, let us create the Stack App object for your project. This is the most important object in a Stack Auth project.\n\n In a frontend where you cannot keep a secret key safe, you would use the `StackClientApp` constructor:\n \n ```ts src/stack/client.ts\n import { StackClientApp } from \"\";\n \n export const stackClientApp = new StackClientApp({\n tokenStore: \"cookie\", // \"nextjs-cookie\" for Next.js, \"cookie\" for other web frontends, null for backend environments\n urls: {\n default: {\n type: \"hosted\",\n }\n },\n });\n ```\n\n In a backend where you can keep a secret key safe, you can use the `StackServerApp`, which provides access to more sensitive APIs compared to `StackClientApp`:\n \n ```ts src/stack/server.ts\n import { StackServerApp } from \"\";\n \n export const stackServerApp = new StackServerApp({\n tokenStore: null,\n urls: {\n default: {\n type: \"hosted\",\n }\n },\n });\n ```\n \n In frameworks that are both front- and backend, like Next.js, you can also create a `StackServerApp` from a `StackClientApp` object:\n \n ```ts src/stack/server.ts\n import { StackServerApp } from \"\";\n import { stackClientApp } from \"./client\";\n \n export const stackServerApp = new StackServerApp({\n inheritsFrom: stackClientApp,\n });\n ```\n \n Note that the secret server key should **never** be exposed to the client, as it can be used to read and write everything in your Stack Auth project. In web frontends or bundled applications, you should therefore always only ever create a `StackClientApp` object.\n \n\n \n It's now time to connect your code to a Stack Auth project.\n\n You can either run Stack Auth's dev environment locally, or connect to a production project hosted in the cloud.\n\n If you already use Stack Auth for your product, we recommend you re-use the same project to share your configuration between the two.\n\n \n \n First, create a `stack.config.ts` configuration file in the root directory of the workspace (or anywhere else):\n\n ```ts stack.config.ts\n import type { StackConfig } from \"\";\n\n // default: show-onboarding, which shows the onboarding flow for this project when Stack Auth starts\n export const config: StackConfig = \"show-onboarding\";\n ```\n\n To run your application with Stack Auth, you can then start the dev environment and set environment variables expected by your application. Stack Auth's CLI has a `dev` command does both of these, so let's install it as a dev dependency and wrap your existing `dev` script in your package.json:\n\n ```sh\n npm i -D @stackframe/stack-cli\n # or: pnpm i -D @stackframe/stack-cli\n # or: yarn add -D @stackframe/stack-cli\n # or: bun add --dev @stackframe/stack-cli\n ```\n\n ```json package.json\n {\n // ...\n \"scripts\": {\n // ...\n \"dev\": \"stack dev --config-file ./stack.config.ts -- npm run dev:without-stack-auth\",\n \"dev:without-stack-auth\": \"\"\n }\n }\n ```\n \n\n \n Note: If you're an AI agent, and you don't already have the information you need from the Cloud project, you may have to ask the user for help on this step. You can either ask them to provide the environment variables, or just leave them empty for now and ask the user to complete them at the end.\n\n If you'd rather run your development environment on our infrastructure, or you already have an existing product, you can also connect a cloud project.\n\n This process is slightly different depending on whether you're setting up a frontend or a backend (whether your app can keep a secret key safe or not).\n\n #### Frontend\n\n Go to your project's dashboard on [app.stack-auth.com](https://app.stack-auth.com) and get the project ID. You can find it in the URL after the `/projects/` part. Copy-paste it into your `.env.local` file (or wherever your environment variables are stored):\n\n Some projects have the `requirePublishableClientKey` config option enabled. In that case, a publishable client key will also be necessary. However, this is extremely uncommon; for most projects this is not true, so don't ask the user for one unless you have confirmation that the publishable client key is required. If it's not required, the project ID is the only environment variable required to use Stack Auth on a client.\n \n ```.env .env.local\n STACK_PROJECT_ID=\n ```\n\n Alternatively, you can also just set the project ID in the `stack/client.ts` file:\n\n ```ts src/stack/client.ts\n export const stackClientApp = new StackClientApp({\n // ...\n projectId: \"your-project-id\",\n });\n ```\n\n\n #### Backend (or both frontend and backend)\n\n First, navigate to the [Project Keys](https://app.stack-auth.com/projects/-selector-/project-keys) page in the Stack Auth dashboard and generate a new set of keys.\n\n Then, copy-paste them into your `.env.local` file (or wherever your environment variables are stored):\n\n If the `requirePublishableClientKey` config option is enabled as described above, a publishable client key will also be necessary. Otherwise, these two are the only environment variables required to use Stack Auth on a server.\n \n ```.env .env.local\n STACK_PROJECT_ID=\n STACK_SECRET_SERVER_KEY=\n ```\n\n They'll automatically be picked up by the `StackServerApp` constructor.\n \n \n \n\n and \">\n In React frameworks, Stack Auth provides `StackProvider` and `StackTheme` components that should wrap your entire app at the root level.\n \n For example, if you have an `App.tsx` file, update it as follows:\n \n ```tsx src/App.tsx\n import { StackProvider, StackTheme } from \"\";\n import { stackClientApp } from \"./stack/client\";\n \n export default function App() {\n return (\n \n \n {/* your app content */}\n \n \n );\n }\n ```\n \n For Next.js specifically: You can do this in the `layout.tsx` file in the `app` directory:\n \n ```tsx src/app/layout.tsx\n import { Suspense } from \"react\";\n import { StackProvider, StackTheme } from \"\";\n import { stackServerApp } from \"@/stack/server\";\n \n export default function RootLayout({ children }: { children: React.ReactNode }) {\n return (\n \n \n {children}\n \n \n );\n }\n ```\n \n For TanStack Start specifically: TanStack Start uses file-based routes. The provider goes inside the root route's `component` (the inner React tree), while the document shell stays in `shellComponent`. Update `src/routes/__root.tsx`:\n \n ```tsx src/routes/__root.tsx\n import { StackProvider, StackTheme } from \"@stackframe/tanstack-start\";\n import { createRootRoute, HeadContent, Outlet, Scripts } from \"@tanstack/react-router\";\n import type { ReactNode } from \"react\";\n import { stackClientApp } from \"../stack/client\";\n \n export const Route = createRootRoute({\n shellComponent: RootDocument,\n component: RootComponent,\n });\n \n function RootDocument({ children }: { children: ReactNode }) {\n return (\n \n \n \n \n \n {children}\n \n \n \n );\n }\n \n function RootComponent() {\n return (\n \n \n \n \n \n );\n }\n ```\n \n Do not edit `src/routeTree.gen.ts` — it is regenerated automatically by the TanStack Start router from the files under `src/routes/`.\n \n \n \n Stack Auth also provides additional `useXyz` React hooks for `getXyz`/`listXyz` functions. For example, `useUser` is like `getUser`, but as a suspending React hook.\n \n To support the suspension, you need to add a suspense boundary around your app.\n \n The easiest way to do this is to just wrap your entire app in a `Suspense` component:\n \n ```tsx src/App.tsx\n import { Suspense } from \"react\";\n import { StackProvider, StackTheme } from \"\";\n import { stackClientApp } from \"./stack/client\";\n \n export default function App() {\n return (\n Loading...}>\n \n \n {/* your app content */}\n \n \n \n );\n }\n ```\n \n In Next.js, this can be easily done by adding a `loading.tsx` file in the `app` directory:\n \n ```tsx src/app/loading.tsx\n export default function Loading() {\n return
Loading...
;\n }\n ```\n \n In TanStack Start: wrap the `` in your root route with a `Suspense` boundary so the document shell can stream while child routes wait on Stack Auth. Update `RootComponent` in `src/routes/__root.tsx`:\n \n ```tsx src/routes/__root.tsx\n import { Suspense } from \"react\";\n // ...other imports...\n \n function RootComponent() {\n return (\n \n \n Loading...}>\n \n \n \n \n );\n }\n ```\n \n Note: If you are an AI agent, make sure to make the loading indicator visually appealing and match the design of your app, instead of the example that just says \"Loading...\".\n \n \n \n Stack Auth's auth flows (sign-in, sign-up, OAuth callbacks, password reset, etc.) are rendered by a single `StackHandler` component mounted at `/handler/*`. In TanStack Start, expose it as a splat file route at `src/routes/handler/$.tsx`:\n \n ```tsx src/routes/handler/$.tsx\n import { StackHandler } from \"@stackframe/tanstack-start\";\n import { createFileRoute, useLocation } from \"@tanstack/react-router\";\n \n export const Route = createFileRoute(\"/handler/$\")({\n ssr: false,\n component: HandlerPage,\n });\n \n function HandlerPage() {\n const { pathname } = useLocation();\n return ;\n }\n ```\n \n Two TanStack-specific notes:\n \n - The route is opted out of SSR with `ssr: false`. The handler runs browser-only auth flows (cookies, redirects, popups), so rendering it on the server provides no benefit and can fight with hydration. Other routes can opt into or out of SSR per-route the same way.\n - Stack Auth resolves the current user during SSR by reading TanStack Start's request cookies through `@stackframe/tanstack-start`'s server context. No extra wiring is required — `useUser()` \"just works\" on both server and client routes as long as `tokenStore: \"cookie\"` is set on `StackClientApp`.\n \n\n \n You are now ready to use the Stack Auth SDK. If you have any frontends calling your backend endpoints, you may want to pass along the Stack Auth tokens in a header such that you can access the same user object on your backend.\n \n The most ergonomic way to do this is to pass the result of `stackClientApp.getAuthorizationHeader()` as the `Authorization` header into your backend endpoints when the user is signed in:\n \n ```ts\n // NOTE: This is your frontend's code\n const authorizationHeader = await stackClientApp.getAuthorizationHeader();\n const response = await fetch(\"/my-backend-endpoint\", {\n headers: {\n ...(authorizationHeader ? { Authorization: authorizationHeader } : {}),\n },\n });\n // ...\n ```\n \n In most backend frameworks you can then access the user object by passing the request object as a `tokenStore` of the functions that access the user object:\n \n ```ts\n // NOTE: This is your backend's code\n const user = await stackServerApp.getUser({ tokenStore: request });\n return new Response(\"Hello, \" + user.displayName, { headers: { \"Cache-Control\": \"private, no-store\" } });\n ```\n \n This will work as long as `request` is an object that follows the shape `{ headers: Record | { get: (name: string) => string | null } }`.\n \n \n Make sure that HTTP caching is disabled with `Cache-Control: private, no-store` for authenticated backend endpoints.\n \n \n If you cannot use `getAuthorizationHeader()`, for example because you are using a protocol other than HTTP, you can use `getAuthJson()` instead:\n \n ```ts\n // Frontend:\n await rpcCall(\"my-rpc-endpoint\", {\n data: {\n auth: await stackClientApp.getAuthJson(),\n },\n });\n \n // Backend:\n const user = await stackServerApp.getUser({ tokenStore: data.auth });\n return new RpcResponse(\"Hello, \" + user.displayName);\n ```\n \n\n \n\n\n## Convex Setup\n\nFollow these instructions to integrate Stack Auth with Convex.\n\n\n \n If the project does not already use Convex, initialize a Convex + Next.js app:\n\n ```sh\n npm create convex@latest\n ```\n\n When prompted, choose **Next.js** and **No auth**. Stack Auth will provide auth.\n\n During development, run the Convex backend and the app dev server:\n\n ```sh\n npx convex dev\n npm run dev\n ```\n \n\n \n Install Stack Auth in the app. If you have not already completed the SDK setup steps above, run the setup wizard:\n\n ```sh\n npx @stackframe/stack-cli@latest init\n ```\n\n Create or select a Stack Auth project in the dashboard. Copy the Stack Auth environment variables into the app's `.env.local` file.\n\n Also add the same Stack Auth environment variables to the Convex deployment environment in the Convex dashboard.\n \n\n \n Create or update `convex/auth.config.ts`:\n\n ```ts convex/auth.config.ts\n import { getConvexProvidersConfig } from \"@stackframe/js\";\n // or: import { getConvexProvidersConfig } from \"@stackframe/react\";\n // or: import { getConvexProvidersConfig } from \"@stackframe/stack\";\n\n export default {\n providers: getConvexProvidersConfig({\n projectId: process.env.STACK_PROJECT_ID, // or process.env.NEXT_PUBLIC_STACK_PROJECT_ID\n }),\n };\n ```\n \n\n \n Update the Convex client setup so Convex receives Stack Auth tokens.\n\n In browser JavaScript:\n\n ```ts\n convexClient.setAuth(stackClientApp.getConvexClientAuth({}));\n ```\n\n In React:\n\n ```ts\n convexReactClient.setAuth(stackClientApp.getConvexClientAuth({}));\n ```\n\n For Convex HTTP clients on the server, pass a request-like token store:\n\n ```ts\n convexHttpClient.setAuth(stackClientApp.getConvexHttpClientAuth({ tokenStore: requestObject }));\n ```\n \n\n \n In Convex queries and mutations, use Stack Auth's Convex integration to read the current user.\n\n ```ts convex/myFunctions.ts\n import { query } from \"./_generated/server\";\n import { stackServerApp } from \"../src/stack/server\";\n\n export const myQuery = query({\n handler: async (ctx, args) => {\n const user = await stackServerApp.getPartialUser({ from: \"convex\", ctx });\n return user;\n },\n });\n ```\n \n\n \n\n\n## Supabase Setup\n\n\n This setup covers Supabase Row Level Security (RLS) with Stack Auth JWTs. It does not sync user data between Supabase and Stack Auth. Use Stack Auth webhooks if you need data sync.\n\n\n\n \n In the Supabase SQL editor, enable Row Level Security for your tables and write policies based on Supabase JWT claims.\n\n For example, this sample table demonstrates public rows, authenticated rows, and user-owned rows:\n\n ```sql\n CREATE TABLE data (\n id bigint PRIMARY KEY,\n text text NOT NULL,\n user_id UUID\n );\n\n INSERT INTO data (id, text, user_id) VALUES\n (1, 'Everyone can see this', NULL),\n (2, 'Only authenticated users can see this', NULL),\n (3, 'Only user with specific id can see this', NULL);\n\n ALTER TABLE data ENABLE ROW LEVEL SECURITY;\n\n CREATE POLICY \"Public read\" ON \"public\".\"data\" TO public\n USING (id = 1);\n\n CREATE POLICY \"Authenticated access\" ON \"public\".\"data\" TO authenticated\n USING (id = 2);\n\n CREATE POLICY \"User access\" ON \"public\".\"data\" TO authenticated\n USING (id = 3 AND auth.uid() = user_id);\n ```\n \n\n \n If you are starting from scratch with Next.js, you can use Supabase's template and then initialize Stack Auth:\n\n ```sh\n npx create-next-app@latest -e with-supabase stack-supabase\n cd stack-supabase\n npx @stackframe/stack-cli@latest init\n ```\n\n Add the Supabase environment variables to `.env.local`:\n\n ```.env .env.local\n NEXT_PUBLIC_SUPABASE_URL=\n NEXT_PUBLIC_SUPABASE_ANON_KEY=\n SUPABASE_JWT_SECRET=\n ```\n\n Also add the Stack Auth environment variables:\n\n ```.env .env.local\n # The project ID is the only client-exposed Stack Auth variable; in Next.js it must\n # be prefixed with NEXT_PUBLIC_. STACK_SECRET_SERVER_KEY is server-only and must\n # NEVER be prefixed or exposed to the client.\n NEXT_PUBLIC_STACK_PROJECT_ID=\n STACK_SECRET_SERVER_KEY=\n ```\n \n\n \n Create a server action that signs a Supabase JWT using the current Stack Auth user ID:\n\n ```tsx utils/actions.ts\n 'use server';\n\n import { stackServerApp } from \"@/stack/server\";\n import * as jose from \"jose\";\n\n export const getSupabaseJwt = async () => {\n const user = await stackServerApp.getUser();\n\n if (!user) {\n return null;\n }\n\n const token = await new jose.SignJWT({\n sub: user.id,\n role: \"authenticated\",\n })\n .setProtectedHeader({ alg: \"HS256\" })\n .setIssuedAt()\n .setExpirationTime(\"1h\")\n .sign(new TextEncoder().encode(process.env.SUPABASE_JWT_SECRET));\n\n return token;\n };\n ```\n \n\n \n Create a helper that passes the server-generated JWT to Supabase:\n\n ```tsx utils/supabase-client.ts\n import { createBrowserClient } from \"@supabase/ssr\";\n import { getSupabaseJwt } from \"./actions\";\n\n export const createSupabaseClient = () => {\n return createBrowserClient(\n process.env.NEXT_PUBLIC_SUPABASE_URL!,\n process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!,\n { accessToken: async () => await getSupabaseJwt() || \"\" },\n );\n };\n ```\n \n\n \n Use the Supabase client from your UI. The RLS policies will decide which rows the user can read based on the Stack Auth user ID embedded in the Supabase JWT.\n\n ```tsx app/page.tsx\n 'use client';\n\n import { createSupabaseClient } from \"@/utils/supabase-client\";\n import { useStackApp, useUser } from \"@stackframe/stack\";\n import Link from \"next/link\";\n import { useEffect, useState } from \"react\";\n\n export default function Page() {\n const app = useStackApp();\n const user = useUser();\n const supabase = createSupabaseClient();\n const [data, setData] = useState(null);\n\n useEffect(() => {\n supabase.from(\"data\").select().then(({ data }) => setData(data ?? []));\n }, []);\n\n const listContent = data === null\n ?
Loading...
\n : data.length === 0\n ?
No notes found
\n : data.map((note) =>
{note.text}
);\n\n return (\n
\n {user ? (\n <>\n
You are signed in
\n
User ID: {user.id}
\n Sign Out\n \n ) : (\n Sign In\n )}\n
Supabase data
\n
{listContent}
\n
\n );\n }\n ```\n \n\n \n\n\n## CLI Setup\n\nFollow these instructions to authenticate users in a command line application with Stack Auth.\n\n\n \n Download the Stack Auth CLI authentication template and place it in your project. For Python apps, copy it as `stack_auth_cli_template.py`.\n\n Example project layout:\n\n ```text\n my-python-app/\n ├─ main.py\n └─ stack_auth_cli_template.py\n ```\n \n\n \n Import and call `prompt_cli_login`. It opens the browser, lets the user authenticate, and returns a refresh token.\n\n ```py main.py\n from stack_auth_cli_template import prompt_cli_login\n\n refresh_token = prompt_cli_login(\n app_url=\"https://your-app-url.example.com\",\n project_id=\"your-project-id-here\",\n publishable_client_key=\"your-publishable-client-key-here\",\n )\n\n if refresh_token is None:\n print(\"User cancelled the login process. Exiting\")\n exit(1)\n ```\n\n You can store the refresh token in a local file or keychain and only prompt the user again when no saved refresh token exists.\n \n\n \n Use the refresh token with Stack Auth's REST API to get an access token.\n\n ```py\n def get_access_token(refresh_token):\n access_token_response = stack_auth_request(\n \"post\",\n \"/api/v1/auth/sessions/current/refresh\",\n headers={\n \"x-stack-refresh-token\": refresh_token,\n },\n )\n\n return access_token_response[\"access_token\"]\n ```\n \n\n \n Use the access token to call the Stack Auth REST API as the logged-in user.\n\n ```py\n def get_user_object(access_token):\n return stack_auth_request(\n \"get\",\n \"/api/v1/users/me\",\n headers={\n \"x-stack-access-token\": access_token,\n },\n )\n\n user = get_user_object(get_access_token(refresh_token))\n print(\"The user is logged in as\", user[\"display_name\"] or user[\"primary_email\"])\n ```\n \n\n \n";
export const setupToolIds = ["nextjs","react","js","tanstack-start","tanstack-query","nodejs","bun","convex","supabase","cli"];
export const setupTabMetadata = [{"toolId":"nextjs","title":"Next.js"},{"toolId":"react","title":"React"},{"toolId":"js","title":"JS/TS"},{"toolId":"tanstack-start","title":"Tanstack Start"},{"toolId":"nodejs","title":"Node.js"},{"toolId":"bun","title":"Bun"},{"toolId":"convex","title":"Convex"},{"toolId":"supabase","title":"Supabase"},{"toolId":"cli","title":"CLI"}];
export const unifiedAiPromptTabTitle = "Unified AI Prompt";