diff --git a/docs/platforms/javascript/guides/nuxt/index.mdx b/docs/platforms/javascript/guides/nuxt/index.mdx index 93ebccb991836d..13b943b99f4478 100644 --- a/docs/platforms/javascript/guides/nuxt/index.mdx +++ b/docs/platforms/javascript/guides/nuxt/index.mdx @@ -14,37 +14,13 @@ categories: ## Install - - - + -To install Sentry using the installation wizard, run the following command within your project: + -The wizard then guides you through the setup process, asking you to enable additional (optional) Sentry features for your application beyond error monitoring. + - - - -```bash -npx @sentry/wizard@latest -i nuxt -``` - - - - - - - -This guide assumes that you enable all features and allow the wizard to create an example page or component. You can add or remove features at any time, but setting them up now will save you the effort of configuring them manually later. - - -- Creates `sentry.(client|server).config.ts` to initialize the SDK -- Creates or updates your `nuxt.config.ts` to add build options to add source maps upload and auto-instrumentation via Vite plugins -- Creates `.env.sentry-build-plugin` with an auth token to upload source maps (this file is automatically added to `.gitignore`) -- Adds an example page and route to your application to help verify your Sentry setup - - If it couldn't create a page, the wizard adds an example component instead - - + ## Avoid Ad Blockers With Tunneling (Optional) @@ -52,7 +28,9 @@ This guide assumes that you enable all features and allow the wizard to create a ## Verify Your Setup -If you haven't tested your Sentry configuration yet, let's do it now. You can confirm that Sentry is working properly and sending data to your Sentry project by using the example page created by the installation wizard. +The `sentry init` command checks the integration files it creates or modifies before it finishes. To confirm runtime events are reaching Sentry, start your Nuxt app, exercise the parts of your app that should send events, and then check your Sentry project. + +If you used the Nuxt installation wizard instead, you can also verify your setup with the example page or component it creates. The wizard creates a `SentryErrorButton` component when it fails to add an example page to your project. This usually happens if you don't have a `app.vue` file or if that file does not contain the `NuxtPage` component. To verify your setup, follow these steps before continuing with the next section, "View Captured Data in Sentry": @@ -116,7 +94,7 @@ NODE_OPTIONS='--import ./.nuxt/dev/sentry.server.config.mjs' nuxt dev -After building and running your project: +If you used the Nuxt installation wizard, after building and running your project: 1. Open the example page `/sentry-example-page` in your browser. For most Nuxt applications, this will be at localhost. 2. Click the "Throw sample error" button. This triggers two errors: diff --git a/docs/platforms/javascript/guides/nuxt/manual-setup.mdx b/docs/platforms/javascript/guides/nuxt/manual-setup.mdx index 42767353eb1c61..17a7d9f7013595 100644 --- a/docs/platforms/javascript/guides/nuxt/manual-setup.mdx +++ b/docs/platforms/javascript/guides/nuxt/manual-setup.mdx @@ -4,9 +4,6 @@ sidebar_order: 1 description: "Learn how to manually set up Sentry in your Nuxt app and capture your first errors." --- - - For the fastest setup, we recommend using the [wizard - installer](/platforms/javascript/guides/nuxt). - + diff --git a/docs/platforms/javascript/guides/react-router/index.mdx b/docs/platforms/javascript/guides/react-router/index.mdx index 4a4f665b87f642..b623de90adfd0f 100644 --- a/docs/platforms/javascript/guides/react-router/index.mdx +++ b/docs/platforms/javascript/guides/react-router/index.mdx @@ -33,58 +33,13 @@ If you're using React Router in data or declarative mode, follow the instruction ## Install - + -The AI-powered `sentry init` flow is currently experimental. To use the existing framework-specific setup instead, see the option below, or check out the [Manual Setup](/platforms/javascript/guides/react-router/manual-setup/) guide. + - - - - - - -Run the Sentry init command in your project directory to automatically configure Sentry in your React Router v7 Framework Mode application. + -The command guides you through setup and asks which optional Sentry features you want to enable beyond error monitoring. - - - - -```bash -npx sentry@latest init -``` - - - - - - - - -The `sentry init` command is AI-powered. It analyzes your project and generates a tailored integration, rather than applying a fixed template. Here's what it does: - -- **Analyzes your project** — reads project files and manifests to understand your React Router Framework app structure, including monorepos. It also respects AI instruction files such as `CLAUDE.md`, `AGENTS.md`, and `.cursorrules`. -- **Detects your framework** — identifies React Router v7 Framework Mode and selects the `@sentry/react-router` SDK. -- **Fetches official Sentry docs** — uses the current Sentry documentation as the source of truth when generating integration code. -- **Installs dependencies** — adds `@sentry/react-router` using your project's package manager. -- **Creates and modifies files** — sets up client-side and server-side initialization, error capture, tracing, and other selected features based on your existing project structure. -- **Verifies the integration** — re-reads modified files after writing to confirm Sentry was integrated. - -For full details on what each file does, see the [Manual Setup](/platforms/javascript/guides/react-router/manual-setup/) guide. - - - - - -If you don't want to use the experimental AI-powered flow, run the framework-specific installation wizard instead: - -```bash -npx @sentry/wizard@latest -i reactRouter -``` - -To configure Sentry manually, follow the [Manual Setup](/platforms/javascript/guides/react-router/manual-setup/) guide. - - + ## Configure diff --git a/docs/platforms/javascript/guides/react-router/manual-setup.mdx b/docs/platforms/javascript/guides/react-router/manual-setup.mdx index 4b20938145a844..2d0998fe213a18 100644 --- a/docs/platforms/javascript/guides/react-router/manual-setup.mdx +++ b/docs/platforms/javascript/guides/react-router/manual-setup.mdx @@ -11,12 +11,7 @@ description: "Learn how to manually set up Sentry in your React Router v7 app an you have any feedback or concerns. - - Looking for automatic setup with `sentry init` or the React Router Framework - Mode wizard? Follow the [React Router quickstart](/platforms/javascript/guides/react-router/) - instead. - Continue with this guide to set up Sentry manually. - + diff --git a/docs/platforms/javascript/guides/sveltekit/index.mdx b/docs/platforms/javascript/guides/sveltekit/index.mdx index c221b1a7011605..c8e3acc4390fa3 100644 --- a/docs/platforms/javascript/guides/sveltekit/index.mdx +++ b/docs/platforms/javascript/guides/sveltekit/index.mdx @@ -16,58 +16,13 @@ categories: ## Install - + -The AI-powered `sentry init` flow is currently experimental. To use the existing framework-specific setup instead, see the option below, or check out the [Manual Setup](/platforms/javascript/guides/sveltekit/manual-setup/) guide. + - - - - - - -Run the Sentry init command in your project directory to automatically configure Sentry in your SvelteKit application. - -The command guides you through setup and asks which optional Sentry features you want to enable beyond error monitoring. - - - - - -```bash -npx sentry@latest init -``` - - - - - - - -The `sentry init` command is AI-powered. It analyzes your project and generates a tailored integration, rather than applying a fixed template. Here's what it does: + -- **Analyzes your project** — reads project files and manifests to understand your SvelteKit app structure, including monorepos. It also respects AI instruction files such as `CLAUDE.md`, `AGENTS.md`, and `.cursorrules`. -- **Detects your framework** — identifies SvelteKit and selects the `@sentry/sveltekit` SDK. -- **Fetches official Sentry docs** — uses the current Sentry documentation as the source of truth when generating integration code. -- **Installs dependencies** — adds `@sentry/sveltekit` using your project's package manager. -- **Creates and modifies files** — sets up client-side and server-side initialization, SvelteKit hooks or instrumentation, and other selected features based on your SvelteKit version and project structure. -- **Verifies the integration** — re-reads modified files after writing to confirm Sentry was integrated. - -For full details on what each file does, see the [Manual Setup](/platforms/javascript/guides/sveltekit/manual-setup/) guide. - - - - - -If you don't want to use the experimental AI-powered flow, run the framework-specific installation wizard instead: - -```bash -npx @sentry/wizard@latest -i sveltekit -``` - -To configure Sentry manually, follow the [Manual Setup](/platforms/javascript/guides/sveltekit/manual-setup/) guide. - - + ## Avoid Ad Blockers With Tunneling (Optional) diff --git a/docs/platforms/javascript/guides/sveltekit/manual-setup.mdx b/docs/platforms/javascript/guides/sveltekit/manual-setup.mdx index 1982a7a65a9f69..40798f202122d6 100644 --- a/docs/platforms/javascript/guides/sveltekit/manual-setup.mdx +++ b/docs/platforms/javascript/guides/sveltekit/manual-setup.mdx @@ -4,10 +4,6 @@ sidebar_order: 1 description: "Learn how to manually set up Sentry in your SvelteKit app and capture your first errors." --- - - Looking for automatic setup with `sentry init` or the SvelteKit wizard? Follow - the [SvelteKit quickstart](/platforms/javascript/guides/sveltekit/) instead. - Continue with this guide to set up Sentry manually. - + diff --git a/docs/platforms/javascript/guides/tanstackstart-react/index.mdx b/docs/platforms/javascript/guides/tanstackstart-react/index.mdx index f6e6f45f9abf3f..2aabba6516e866 100644 --- a/docs/platforms/javascript/guides/tanstackstart-react/index.mdx +++ b/docs/platforms/javascript/guides/tanstackstart-react/index.mdx @@ -24,32 +24,13 @@ Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issu ## Install - + -The wizard is currently experimental. If you run into any issues, check out the [Manual Setup](/platforms/javascript/guides/tanstackstart-react/manual-setup/) guide. + - - -Run the Sentry init command to automatically configure Sentry in your TanStack Start React application: - -```bash -npx sentry@latest init -``` - - + -The Sentry init wizard is AI-powered — it analyzes your project and generates a tailored integration, rather than applying a fixed template. Here's what it does: - -- **Analyzes your project** — reads your project's files and manifests to understand its structure, including monorepos. It also respects any AI instruction files you have (`CLAUDE.md`, `AGENTS.md`, `.cursorrules`, etc.). -- **Detects your framework** — identifies TanStack Start and selects the right SDK (`@sentry/tanstackstart-react`) -- **Fetches official Sentry docs** — uses the current Sentry documentation as the source of truth when generating your integration code, so you always get up-to-date setup -- **Installs dependencies** — adds `@sentry/tanstackstart-react` using your project's package manager -- **Creates and modifies files** — sets up client-side and server-side initialization, the Vite plugin for source maps, the server entry point, and middleware — all adapted to your project's structure -- **Verifies the integration** — re-reads the modified files after writing to confirm Sentry was correctly integrated - -For full details on what each file does, see the [Manual Setup](/platforms/javascript/guides/tanstackstart-react/manual-setup/) guide. - - + ## Verify Your Setup diff --git a/docs/platforms/javascript/guides/tanstackstart-react/manual-setup/index.mdx b/docs/platforms/javascript/guides/tanstackstart-react/manual-setup/index.mdx index 5d763ef7558e15..4eae64e6399c97 100644 --- a/docs/platforms/javascript/guides/tanstackstart-react/manual-setup/index.mdx +++ b/docs/platforms/javascript/guides/tanstackstart-react/manual-setup/index.mdx @@ -10,11 +10,7 @@ categories: - browser --- - - -For the fastest setup, we recommend using the [installation wizard](/platforms/javascript/guides/tanstackstart-react/). - - + diff --git a/platform-includes/sentry-init/experimental-warning/_default.mdx b/platform-includes/sentry-init/experimental-warning/_default.mdx new file mode 100644 index 00000000000000..8308e0ef17bcc3 --- /dev/null +++ b/platform-includes/sentry-init/experimental-warning/_default.mdx @@ -0,0 +1,5 @@ + + +The AI-powered `sentry init` flow is currently experimental. To use the existing framework-specific setup instead, see the option below, or check out the Manual Setup guide. + + diff --git a/platform-includes/sentry-init/experimental-warning/javascript.tanstackstart-react.mdx b/platform-includes/sentry-init/experimental-warning/javascript.tanstackstart-react.mdx new file mode 100644 index 00000000000000..8d8a825dae0766 --- /dev/null +++ b/platform-includes/sentry-init/experimental-warning/javascript.tanstackstart-react.mdx @@ -0,0 +1,5 @@ + + +The AI-powered `sentry init` flow is currently experimental. If you run into any issues, check out the Manual Setup guide. + + diff --git a/platform-includes/sentry-init/framework-wizard/javascript.nuxt.mdx b/platform-includes/sentry-init/framework-wizard/javascript.nuxt.mdx new file mode 100644 index 00000000000000..66c679c4b4ffc2 --- /dev/null +++ b/platform-includes/sentry-init/framework-wizard/javascript.nuxt.mdx @@ -0,0 +1,11 @@ + + +If you don't want to use the experimental AI-powered flow, run the framework-specific installation wizard instead: + +```bash +npx @sentry/wizard@latest -i nuxt +``` + +To configure Sentry manually, follow the Manual Setup guide. + + diff --git a/platform-includes/sentry-init/framework-wizard/javascript.react-router.mdx b/platform-includes/sentry-init/framework-wizard/javascript.react-router.mdx new file mode 100644 index 00000000000000..43643e2d4f7b2b --- /dev/null +++ b/platform-includes/sentry-init/framework-wizard/javascript.react-router.mdx @@ -0,0 +1,11 @@ + + +If you don't want to use the experimental AI-powered flow, run the framework-specific installation wizard instead: + +```bash +npx @sentry/wizard@latest -i reactRouter +``` + +To configure Sentry manually, follow the Manual Setup guide. + + diff --git a/platform-includes/sentry-init/framework-wizard/javascript.sveltekit.mdx b/platform-includes/sentry-init/framework-wizard/javascript.sveltekit.mdx new file mode 100644 index 00000000000000..98c1d02693ba73 --- /dev/null +++ b/platform-includes/sentry-init/framework-wizard/javascript.sveltekit.mdx @@ -0,0 +1,11 @@ + + +If you don't want to use the experimental AI-powered flow, run the framework-specific installation wizard instead: + +```bash +npx @sentry/wizard@latest -i sveltekit +``` + +To configure Sentry manually, follow the Manual Setup guide. + + diff --git a/platform-includes/sentry-init/how-it-works/javascript.nuxt.mdx b/platform-includes/sentry-init/how-it-works/javascript.nuxt.mdx new file mode 100644 index 00000000000000..62e3be67a15324 --- /dev/null +++ b/platform-includes/sentry-init/how-it-works/javascript.nuxt.mdx @@ -0,0 +1,14 @@ + + +The `sentry init` command is AI-powered. It analyzes your project and generates a tailored integration, rather than applying a fixed template. Here's what it does: + +- **Analyzes your project** — reads project files and manifests to understand your Nuxt app structure, including monorepos. It also respects AI instruction files such as `CLAUDE.md`, `AGENTS.md`, and `.cursorrules`. +- **Detects your framework** — identifies Nuxt and selects the `@sentry/nuxt` SDK. +- **Fetches official Sentry docs** — uses the current Sentry documentation as the source of truth when generating integration code. +- **Installs dependencies** — adds `@sentry/nuxt` using your project's package manager. +- **Creates and modifies files** — sets up client-side and server-side initialization, Nuxt module configuration, and other selected features based on your project structure. +- **Verifies the integration** — re-reads modified files after writing to confirm Sentry was integrated. + +For full details on what each file does, see the Manual Setup guide. + + diff --git a/platform-includes/sentry-init/how-it-works/javascript.react-router.mdx b/platform-includes/sentry-init/how-it-works/javascript.react-router.mdx new file mode 100644 index 00000000000000..9f3ec22a3d8263 --- /dev/null +++ b/platform-includes/sentry-init/how-it-works/javascript.react-router.mdx @@ -0,0 +1,14 @@ + + +The `sentry init` command is AI-powered. It analyzes your project and generates a tailored integration, rather than applying a fixed template. Here's what it does: + +- **Analyzes your project** — reads project files and manifests to understand your React Router Framework app structure, including monorepos. It also respects AI instruction files such as `CLAUDE.md`, `AGENTS.md`, and `.cursorrules`. +- **Detects your framework** — identifies React Router v7 Framework Mode and selects the `@sentry/react-router` SDK. +- **Fetches official Sentry docs** — uses the current Sentry documentation as the source of truth when generating integration code. +- **Installs dependencies** — adds `@sentry/react-router` using your project's package manager. +- **Creates and modifies files** — sets up client-side and server-side initialization, error capture, tracing, and other selected features based on your existing project structure. +- **Verifies the integration** — re-reads modified files after writing to confirm Sentry was integrated. + +For full details on what each file does, see the Manual Setup guide. + + diff --git a/platform-includes/sentry-init/how-it-works/javascript.sveltekit.mdx b/platform-includes/sentry-init/how-it-works/javascript.sveltekit.mdx new file mode 100644 index 00000000000000..16bc12169242d0 --- /dev/null +++ b/platform-includes/sentry-init/how-it-works/javascript.sveltekit.mdx @@ -0,0 +1,14 @@ + + +The `sentry init` command is AI-powered. It analyzes your project and generates a tailored integration, rather than applying a fixed template. Here's what it does: + +- **Analyzes your project** — reads project files and manifests to understand your SvelteKit app structure, including monorepos. It also respects AI instruction files such as `CLAUDE.md`, `AGENTS.md`, and `.cursorrules`. +- **Detects your framework** — identifies SvelteKit and selects the `@sentry/sveltekit` SDK. +- **Fetches official Sentry docs** — uses the current Sentry documentation as the source of truth when generating integration code. +- **Installs dependencies** — adds `@sentry/sveltekit` using your project's package manager. +- **Creates and modifies files** — sets up client-side and server-side initialization, SvelteKit hooks or instrumentation, and other selected features based on your SvelteKit version and project structure. +- **Verifies the integration** — re-reads modified files after writing to confirm Sentry was integrated. + +For full details on what each file does, see the Manual Setup guide. + + diff --git a/platform-includes/sentry-init/how-it-works/javascript.tanstackstart-react.mdx b/platform-includes/sentry-init/how-it-works/javascript.tanstackstart-react.mdx new file mode 100644 index 00000000000000..323fec1f261915 --- /dev/null +++ b/platform-includes/sentry-init/how-it-works/javascript.tanstackstart-react.mdx @@ -0,0 +1,14 @@ + + +The `sentry init` command is AI-powered. It analyzes your project and generates a tailored integration, rather than applying a fixed template. Here's what it does: + +- **Analyzes your project** — reads project files and manifests to understand your TanStack Start React app structure, including monorepos. It also respects AI instruction files such as `CLAUDE.md`, `AGENTS.md`, and `.cursorrules`. +- **Detects your framework** — identifies TanStack Start and selects the `@sentry/tanstackstart-react` SDK. +- **Fetches official Sentry docs** — uses the current Sentry documentation as the source of truth when generating integration code. +- **Installs dependencies** — adds `@sentry/tanstackstart-react` using your project's package manager. +- **Creates and modifies files** — sets up client-side and server-side initialization, the Vite plugin for source maps, the server entry point, and middleware based on your project structure. +- **Verifies the integration** — re-reads modified files after writing to confirm Sentry was integrated. + +For full details on what each file does, see the Manual Setup guide. + + diff --git a/platform-includes/sentry-init/install-command/_default.mdx b/platform-includes/sentry-init/install-command/_default.mdx new file mode 100644 index 00000000000000..ac2f872fda84d7 --- /dev/null +++ b/platform-includes/sentry-init/install-command/_default.mdx @@ -0,0 +1,19 @@ + + + + +Run the Sentry init command in your project directory to automatically configure Sentry in your application. + +The command guides you through setup and asks which optional Sentry features you want to enable beyond error monitoring. + + + + + +```bash +npx sentry@latest init +``` + + + + diff --git a/platform-includes/sentry-init/install-command/javascript.react-router.mdx b/platform-includes/sentry-init/install-command/javascript.react-router.mdx new file mode 100644 index 00000000000000..938f091d9ca1f0 --- /dev/null +++ b/platform-includes/sentry-init/install-command/javascript.react-router.mdx @@ -0,0 +1,19 @@ + + + + +Run the Sentry init command in your project directory to automatically configure Sentry in your React Router v7 Framework Mode application. + +The command guides you through setup and asks which optional Sentry features you want to enable beyond error monitoring. + + + + +```bash +npx sentry@latest init +``` + + + + + diff --git a/platform-includes/sentry-init/manual-setup-callout/javascript.nuxt.mdx b/platform-includes/sentry-init/manual-setup-callout/javascript.nuxt.mdx new file mode 100644 index 00000000000000..6d24e7f79b96af --- /dev/null +++ b/platform-includes/sentry-init/manual-setup-callout/javascript.nuxt.mdx @@ -0,0 +1,5 @@ + + Looking for automatic setup with `sentry init` or the Nuxt wizard? Follow the + Nuxt quickstart instead. + Continue with this guide to set up Sentry manually. + diff --git a/platform-includes/sentry-init/manual-setup-callout/javascript.react-router.mdx b/platform-includes/sentry-init/manual-setup-callout/javascript.react-router.mdx new file mode 100644 index 00000000000000..5e9a81227ab94d --- /dev/null +++ b/platform-includes/sentry-init/manual-setup-callout/javascript.react-router.mdx @@ -0,0 +1,6 @@ + + Looking for automatic setup with `sentry init` or the React Router Framework + Mode wizard? Follow the React Router quickstart + instead. + Continue with this guide to set up Sentry manually. + diff --git a/platform-includes/sentry-init/manual-setup-callout/javascript.sveltekit.mdx b/platform-includes/sentry-init/manual-setup-callout/javascript.sveltekit.mdx new file mode 100644 index 00000000000000..58386a1037e534 --- /dev/null +++ b/platform-includes/sentry-init/manual-setup-callout/javascript.sveltekit.mdx @@ -0,0 +1,5 @@ + + Looking for automatic setup with `sentry init` or the SvelteKit wizard? Follow + the SvelteKit quickstart instead. + Continue with this guide to set up Sentry manually. + diff --git a/platform-includes/sentry-init/manual-setup-callout/javascript.tanstackstart-react.mdx b/platform-includes/sentry-init/manual-setup-callout/javascript.tanstackstart-react.mdx new file mode 100644 index 00000000000000..99b53fd8d76fe4 --- /dev/null +++ b/platform-includes/sentry-init/manual-setup-callout/javascript.tanstackstart-react.mdx @@ -0,0 +1,5 @@ + + Looking for automatic setup with `sentry init`? Follow the + TanStack Start React quickstart instead. + Continue with this guide to set up Sentry manually. +