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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions skills/sentry-cocoa-sdk/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,19 @@ Propose: *"I recommend Error Monitoring + Tracing + Profiling. Want me to also a

### Install

**Option 1 — Sentry Wizard (recommended):** Walks you through login, org/project selection, and auth token setup interactively. Then installs the SDK, updates AppDelegate, adds dSYM/debug symbol upload build phases, and configures everything automatically.

```bash
brew install getsentry/tools/sentry-wizard && sentry-wizard -i ios
```
**Option 1 — Sentry Wizard (recommended):**

> **You need to run this yourself** — the wizard opens a browser for login and requires interactive input that the agent can't handle. Copy-paste into your terminal:
>
> ```
> brew install getsentry/tools/sentry-wizard && sentry-wizard -i ios
> ```
>
> It handles login, org/project selection, auth token setup, SDK installation, AppDelegate updates, and dSYM/debug symbol upload build phases.
>
> **Once it finishes, come back and skip to [Verification](#verification).**

If the user skips the wizard, proceed with Option 2 (SPM/CocoaPods) and manual setup below.

**Option 2 — Swift Package Manager:** File → Add Packages → enter:
```
Expand Down
18 changes: 11 additions & 7 deletions skills/sentry-dotnet-sdk/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,17 @@ Propose: *"I recommend setting up Error Monitoring + Tracing + Logging. Want me

### Option 1: Wizard (Recommended)

```bash
npx @sentry/wizard@latest -i dotnet
```

The wizard logs you into Sentry, selects your org and project, configures your DSN, and sets up MSBuild symbol upload for readable stack traces in production.

**Skip to [Verification](#verification) after running the wizard.**
> **You need to run this yourself** — the wizard opens a browser for login and requires interactive input that the agent can't handle. Copy-paste into your terminal:
>
> ```
> npx @sentry/wizard@latest -i dotnet
> ```
>
> It handles login, org/project selection, DSN configuration, and MSBuild symbol upload setup for readable stack traces in production.
>
> **Once it finishes, come back and skip to [Verification](#verification).**

If the user skips the wizard, proceed with Option 2 (Manual Setup) below.

---

Expand Down
18 changes: 11 additions & 7 deletions skills/sentry-nextjs-sdk/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,13 +109,17 @@ Propose: *"I recommend setting up Error Monitoring + Tracing + Session Replay. W

### Option 1: Wizard (Recommended)

```bash
npx @sentry/wizard@latest -i nextjs
```

The wizard walks you through login, org/project selection, and auth token setup interactively — no manual token creation needed. It then installs the SDK, creates all necessary config files (`instrumentation-client.ts`, `sentry.server.config.ts`, `sentry.edge.config.ts`, `instrumentation.ts`), wraps `next.config.ts` with `withSentryConfig()`, configures source map upload, and adds a `/sentry-example-page` for verification.

**Skip to [Verification](#verification) after running the wizard.**
> **You need to run this yourself** — the wizard opens a browser for login and requires interactive input that the agent can't handle. Copy-paste into your terminal:
>
> ```
> npx @sentry/wizard@latest -i nextjs
> ```
>
> It handles login, org/project selection, SDK installation, config files (`instrumentation-client.ts`, `sentry.server.config.ts`, `sentry.edge.config.ts`, `instrumentation.ts`), `next.config.ts` wrapping, source map upload, and adds a `/sentry-example-page`.
>
> **Once it finishes, come back and skip to [Verification](#verification).**

If the user skips the wizard, proceed with Option 2 (Manual Setup) below.

---

Expand Down
42 changes: 22 additions & 20 deletions skills/sentry-react-native-sdk/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,27 +120,29 @@ Propose: *"For your [Expo managed / bare RN] app, I recommend setting up Error M

### Path A: Wizard CLI (Recommended for all project types)

Run the wizard — it walks you through login, org/project selection, and auth token setup interactively. It then handles installation, native config, source map upload, and initial `Sentry.init()`:

```bash
npx @sentry/wizard@latest -i reactNative
```
> **You need to run this yourself** — the wizard opens a browser for login and requires interactive input that the agent can't handle. Copy-paste into your terminal:
>
> ```
> npx @sentry/wizard@latest -i reactNative
> ```
>
> It handles login, org/project selection, SDK installation, native config, source map upload, and `Sentry.init()`. Here's what it creates/modifies:
>
> | File | Action | Purpose |
> |------|--------|---------|
> | `package.json` | Installs `@sentry/react-native` | Core SDK |
> | `metro.config.js` | Adds `@sentry/react-native/metro` serializer | Source map generation |
> | `app.json` | Adds `@sentry/react-native/expo` plugin (Expo only) | Config plugin for native builds |
> | `App.tsx` / `_layout.tsx` | Adds `Sentry.init()` and `Sentry.wrap()` | SDK initialization |
> | `ios/sentry.properties` | Stores org/project/token | iOS source map + dSYM upload |
> | `android/sentry.properties` | Stores org/project/token | Android source map upload |
> | `android/app/build.gradle` | Adds Sentry Gradle plugin | Android source maps + proguard |
> | `ios/[AppName].xcodeproj` | Wraps "Bundle RN" build phase + adds dSYM upload | iOS symbol upload |
> | `.env.local` | `SENTRY_AUTH_TOKEN` | Auth token (add to `.gitignore`) |
>
> **Once it finishes, come back and skip to [Verification](#verification).**

**What the wizard creates/modifies:**

| File | Action | Purpose |
|------|--------|---------|
| `package.json` | Installs `@sentry/react-native` | Core SDK |
| `metro.config.js` | Adds `@sentry/react-native/metro` serializer | Source map generation |
| `app.json` | Adds `@sentry/react-native/expo` plugin (Expo only) | Config plugin for native builds |
| `App.tsx` / `_layout.tsx` | Adds `Sentry.init()` and `Sentry.wrap()` | SDK initialization |
| `ios/sentry.properties` | Stores org/project/token | iOS source map + dSYM upload |
| `android/sentry.properties` | Stores org/project/token | Android source map upload |
| `android/app/build.gradle` | Adds Sentry Gradle plugin | Android source maps + proguard |
| `ios/[AppName].xcodeproj` | Wraps "Bundle RN" build phase + adds dSYM upload | iOS symbol upload |
| `.env.local` | `SENTRY_AUTH_TOKEN` | Auth token (add to `.gitignore`) |

After the wizard runs, skip to [Verification](#verification).
If the user skips the wizard, proceed with Path B or C (Manual Setup) below based on their project type.

---

Expand Down
18 changes: 10 additions & 8 deletions skills/sentry-react-sdk/references/react-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -447,15 +447,17 @@ Source maps translate minified production stack traces back to your original sou

The fastest path — automatically detects your bundler, installs the plugin, and configures auth:

```bash
npx @sentry/wizard@latest -i sourcemaps
```
> **You need to run this yourself** — the wizard opens a browser for login and requires interactive input that the agent can't handle. Copy-paste into your terminal:
>
> ```
> npx @sentry/wizard@latest -i sourcemaps
> ```
>
> It detects Vite/webpack/CRA, installs the appropriate Sentry bundler plugin, adds `SENTRY_AUTH_TOKEN` to `.env.sentry-build-plugin`, and configures `sourcemap: "hidden"` with `filesToDeleteAfterUpload`.
>
> **Once it finishes, come back and the agent will continue.**

The wizard:
1. Detects Vite, webpack, or CRA
2. Installs the appropriate Sentry bundler plugin
3. Adds `SENTRY_AUTH_TOKEN` to your `.env.sentry-build-plugin`
4. Configures `sourcemap: "hidden"` and `filesToDeleteAfterUpload`
If the user skips the wizard, proceed with manual bundler plugin setup below.

---

Expand Down
4 changes: 2 additions & 2 deletions skills/sentry-sdk-skill-creator/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ license: Apache-2.0

## Phase 3: Guide
### Option 1: Wizard (Recommended) ← if wizard exists for this framework
[wizard command, what it creates/modifies table, skip-to-verification note]
[blockquote telling the user to run the wizard themselves — it requires interactive browser login. Include the command in a copy-pasteable code block inside the blockquote. Tell them to come back when done. Add a line after the blockquote: "If the user skips the wizard, proceed with Option 2 (Manual Setup) below."]
### Option 2: Manual Setup ← always include
### Install
### Quick Start — Recommended Init
Expand All @@ -186,7 +186,7 @@ license: Apache-2.0
### Key Principles for the Main SKILL.md

1. **Keep it lean** — deep details go in references, not here
2. **Wizard-first for framework SDKs** — if the Sentry wizard supports this framework, present it as "Option 1: Wizard (Recommended)" before any manual setup. The wizard handles the full auth flow (login, org/project selection, auth token creation), source map upload, build tool plugins, and framework-specific wiring — all in one interactive step. See `${SKILL_ROOT}/references/philosophy.md` for the full pattern.
2. **Wizard-first for framework SDKs** — if the Sentry wizard supports this framework, present it as "Option 1: Wizard (Recommended)" before any manual setup. **The wizard requires interactive browser login and cannot be run by the agent** — present it in a blockquote telling the user to copy-paste the command into their own terminal, and come back when done. If the user skips the wizard, the agent proceeds with full manual setup. See `${SKILL_ROOT}/references/philosophy.md` for the full pattern.
3. **Source maps are non-negotiable for frontend/mobile** — the manual setup path must include source map upload configuration (build tool plugin + env vars). Without source maps, production stack traces are unreadable minified code.
4. **Detection commands must be real** — test them against actual projects
5. **Recommendation logic must be opinionated** — "always", "when X detected", not "maybe consider"
Expand Down
27 changes: 17 additions & 10 deletions skills/sentry-sdk-skill-creator/references/philosophy.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,24 +101,31 @@ Recommendation logic:
Many Sentry SDKs ship with a CLI wizard (`npx @sentry/wizard@latest -i <integration>`) that scaffolds the entire setup in one command. **When a wizard integration exists for the target framework, the skill must present it as the primary recommended path — before any manual instructions.**

Why this matters:
- The wizard walks through **authentication interactively** — it opens the browser for login, lets the user select their Sentry org and project, and creates/downloads the auth token automatically. No manual token creation or copy-pasting from the Sentry dashboard.
- The wizard configures **source map upload** automatically — without source maps, production stack traces show minified garbage. This is the single most common setup mistake in frontend projects.
- The wizard handles framework-specific wiring (hook files, config plugins, build tool plugins) that's easy to get wrong manually.
- The wizard creates a test page/component for immediate verification.

**The wizard requires interactive input (browser-based login, org/project selection) and cannot be run by the agent.** The skill must tell the user to run the command themselves in their terminal. If the user skips the wizard, the agent proceeds with full manual setup.

**Pattern for skills with wizard support:**

```markdown
### Option 1: Wizard (Recommended)

\`\`\`bash
npx @sentry/wizard@latest -i <framework>
\`\`\`

The wizard walks you through login, org/project selection, and auth token
setup interactively. It then handles installation, SDK initialization,
source map upload configuration, and creates a test page for verification.
Skip to [Verification](#verification) after running it.
> **You need to run this yourself** — the wizard opens a browser for login
> and requires interactive input that the agent can't handle.
> Copy-paste into your terminal:
>
> \`\`\`
> npx @sentry/wizard@latest -i <framework>
> \`\`\`
>
> It handles login, org/project selection, SDK installation, source map
> upload configuration, and creates a test page for verification.
>
> **Once it finishes, come back and skip to [Verification](#verification).**

If the user skips the wizard, proceed with Option 2 (Manual Setup) below.

### Option 2: Manual Setup

Expand All @@ -145,7 +152,7 @@ Skip to [Verification](#verification) after running it.
| `android` | Android |
| `dotnet` | .NET |

> **Important:** Even when the wizard is available, the skill must still include full manual setup instructions. The wizard may not cover all configuration options, and some users work in environments where interactive CLIs aren't practical (CI, Docker, restricted shells). The manual path is the fallback, not an afterthought — it must be complete.
> **Important:** Even when the wizard is available, the skill must still include full manual setup instructions. The wizard may not cover all configuration options, and some users or agents work in environments where interactive CLIs aren't practical. The manual path is the fallback, not an afterthought — it must be complete.

#### Source Maps: The Non-Negotiable for Frontend

Expand Down
16 changes: 11 additions & 5 deletions skills/sentry-svelte-sdk/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,17 @@ Propose: *"I recommend setting up Error Monitoring + Tracing + Session Replay. W

#### Option 1: Wizard (Recommended)

```bash
npx @sentry/wizard@latest -i sveltekit
```

The wizard walks you through login, org/project selection, and auth token setup interactively — no manual token creation needed. It then installs the SDK, creates all necessary files (client/server hooks, Vite plugin config), configures source map upload, and adds a `/sentry-example-page` for verification. Skip to [Verification](#verification) after running it.
> **You need to run this yourself** — the wizard opens a browser for login and requires interactive input that the agent can't handle. Copy-paste into your terminal:
>
> ```
> npx @sentry/wizard@latest -i sveltekit
> ```
>
> It handles login, org/project selection, SDK installation, client/server hooks, Vite plugin config, source map upload, and adds a `/sentry-example-page`.
>
> **Once it finishes, come back and skip to [Verification](#verification).**

If the user skips the wizard, proceed with Option 2 (Manual Setup) below.

#### Option 2: Manual Setup

Expand Down