README
Sentry Wizard
The Sentry Wizard helps you set up your React Native, Flutter, Apple, Android, Cordova, Electron, Next.js, Nuxt, Remix or SvelteKit projects with Sentry.
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/wizard
With pnpm:
pnpx @sentry/wizard@latest
pnpm 11
pnpm 11 requires explicit approval before dependencies can run build scripts. If the Wizard's package installation
fails with ERR_PNPM_IGNORED_BUILDS, review the packages listed by pnpm and run approve-builds
before re-running the Wizard:
pnpm approve-builds [package-names-to-approve]
Support
At 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 | SENTRY_WIZARD_DEBUG | |
--uninstall | Revert project setup process. Not available for all integrations. | boolean | false | SENTRY_WIZARD_UNINSTALL | |
--skip-connect | Skips the connection to the server | boolean | false | SENTRY_WIZARD_SKIP_CONNECT | |
--quiet | Do not fallback to prompting user asking questions | boolean | false | SENTRY_WIZARD_QUIET | |
-i, --integration | Choose the integration to setup | choices | Select integration during setup | "reactNative", "flutter", ios", "android", "cordova", "angular", "electron", "nextjs", "nuxt", "remix", "sveltekit", "sourcemaps" | SENTRY_WIZARD_INTEGRATION |
-p, --platform | Choose platform(s) | array | Select platform(s) during setup | "ios", "android" | SENTRY_WIZARD_PLATFORM |
-u, --url | The URL to your Sentry installation | string | https://sentry.io | SENTRY_WIZARD_URL | |
--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
Contributors
(top 30 of 98)
Similar repos
Languages
TypeScript
95.0%
C++
1.3%
JavaScript
1.2%
CMake
1.0%
README
Sentry Wizard
The Sentry Wizard helps you set up your React Native, Flutter, Apple, Android, Cordova, Electron, Next.js, Nuxt, Remix or SvelteKit projects with Sentry.
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/wizard
With pnpm:
pnpx @sentry/wizard@latest
pnpm 11
pnpm 11 requires explicit approval before dependencies can run build scripts. If the Wizard's package installation
fails with ERR_PNPM_IGNORED_BUILDS, review the packages listed by pnpm and run approve-builds
before re-running the Wizard:
pnpm approve-builds [package-names-to-approve]
Support
At 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 | SENTRY_WIZARD_DEBUG | |
--uninstall | Revert project setup process. Not available for all integrations. | boolean | false | SENTRY_WIZARD_UNINSTALL | |
--skip-connect | Skips the connection to the server | boolean | false | SENTRY_WIZARD_SKIP_CONNECT | |
--quiet | Do not fallback to prompting user asking questions | boolean | false | SENTRY_WIZARD_QUIET | |
-i, --integration | Choose the integration to setup | choices | Select integration during setup | "reactNative", "flutter", ios", "android", "cordova", "angular", "electron", "nextjs", "nuxt", "remix", "sveltekit", "sourcemaps" | SENTRY_WIZARD_INTEGRATION |
-p, --platform | Choose platform(s) | array | Select platform(s) during setup | "ios", "android" | SENTRY_WIZARD_PLATFORM |
-u, --url | The URL to your Sentry installation | string | https://sentry.io | SENTRY_WIZARD_URL | |
--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
Similar repos
Contributors
(top 30 of 98)
Languages
TypeScript
95.0%
C++
1.3%
JavaScript
1.2%
CMake
1.0%