<p align="center" <a href="https://sentry.io/?utmsource=github&utmmedium=logo" target="blank" <picture <source srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-white.png" media="(prefers-color-scheme: dark)" / <source srcset="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" / <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" alt="Sentry" width="280" </picture </a </p
<h1Sentry Wizard</h1 <h4The Sentry Wizard helps you set up your React Native, Flutter, Apple, Android, Cordova, Electron, Next.js, Nuxt, Remix or SvelteKit projects with Sentry.</h4
[](https://codecov.io/gh/getsentry/sentry-wizard)
Usage
There are multiple ways to run the Wizard.
- Install globally and run it anywhere:
npm install -g @sentry/wizard
# or
yarn global add @sentry/wizard
sentry-wizard- Install and run it in your project with yarn:
yarn add @sentry/wizard
yarn sentry-wizard- Run it directly without installing:
npx @sentry/wizardAt the current moment, the wizard can be used for Next.js, react-native, iOS, Flutter, Nuxt, Remix, Sveltekit, Android, Electron, Cordova, and for sourcemaps setup. If you have other platforms you would like the wizard to support, please open a GitHub issue!
Options
The following CLI arguments are available:
| Option | Description | Type | Default | Choices | Environment Variable | | ---------------------- | ----------------------------------------------------------------- | ------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | | --help | Show help | boolean | | | | | --version | Show version number | boolean | | | | | --debug | Enable verbose logging | boolean | false | | SENTRYWIZARDDEBUG | | --uninstall | Revert project setup process. Not available for all integrations. | boolean | false | | SENTRYWIZARDUNINSTALL | | --skip-connect | Skips the connection to the server | boolean | false | | SENTRYWIZARDSKIPCONNECT | | --quiet | Do not fallback to prompting user asking questions | boolean | false | | SENTRYWIZARDQUIET | | -i, --integration | Choose the integration to setup | choices | Select integration during setup | "reactNative", "flutter", ios", "android", "cordova", "angular", "electron", "nextjs", "nuxt", "remix", "sveltekit", "sourcemaps" | SENTRYWIZARDINTEGRATION | | -p, --platform | Choose platform(s) | array | Select platform(s) during setup | "ios", "android" | SENTRYWIZARDPLATFORM | | -u, --url | The URL to your Sentry installation | string | https://sentry.io | | SENTRYWIZARDURL | | --project | The Sentry project slug to use | string | Select project during setup | | | | --org | The Sentry org slug to use | string | Select org during setup | | | | --saas | Skip the self-hosted or SaaS URL selection process | boolean | Select self-hosted or SaaS during setup | | | | -s, --signup | Redirect to signup page if not logged in | boolean | false | | | | --disable-telemetry | Don't send telemetry data to Sentry | boolean | false | | | | --force-install | Force install the SDK NPM package (use with caution!) | boolean | false | | | | --coming-from | Specify the partner organization initiating this command. | string | | | | | --ignore-git-changes | Ignore git changes in the project and not prompt for confirmation | boolean | false | | |
Resources
- [](https://forum.sentry.io/c/sdks)
- [](https://discord.gg/Ww9hbqr)
- [](http://stackoverflow.com/questions/tagged/sentry)
- [](https://twitter.com/intent/follow?screenname=getsentry)