@sentry/wizard

Sentry wizard helping you to configure your project
2,346,313 295
setup cli sdk sentry wizard project install configure
Install
npm install @sentry/wizard
Latest Version:8.0.1
License:FSL-1.1-MIT
Last Updated:Oct 20, 2026
Links: GitHub  ·  npm
Maintainer: sentry-bot

npm version npm dm npm dt Discord Chat

GitHub Actions Codecov

Wizard in action

Usage

There are multiple ways to run the Wizard.

  1. Install globally and run it anywhere:
npm install -g @sentry/wizard
# or
yarn global add @sentry/wizard

sentry-wizard
  1. Install and run it in your project with yarn:
yarn add @sentry/wizard
yarn sentry-wizard
  1. 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

  • Forum
  • Discord
  • Stack Overflow
  • Twitter Follow

Related Packages

xw-tpl-cli

通过命令 tpl create xx 去快速创建各种大前端框架模版。如 vue2、vue3、react、uniap...

827
cli project create template
@zayn919/minisentry-vue2

Mini Sentry Vue 2 SDK：Vue.config.errorHandler 适配

657
sdk sentry error-monitoring minisentry vue2
@zayn919/minisentry-vue3

Mini Sentry Vue 3 SDK：app.config.errorHandler 适配

630
sdk sentry error-monitoring minisentry vue3
@yukino.js/sentry

Framework-agnostic sentry sdk with first-class support for react and vue3+

195 1
sdk sentry error-tracking monitoring react vue
@poups/nuxt3-capacitor

Interactive script to configure Capacitor with Android and iOS for Nuxt/SPA proj...

1,400
cli setup android capacitor ios mobile nuxt spa

Version History

Version Released License
8.0.1 FSL-1.1-MIT
8.0.0 FSL-1.1-MIT
7.0.3 FSL-1.1-MIT
7.0.2 FSL-1.1-MIT
7.0.1 FSL-1.1-MIT
Pre-releases (6)
Version Released License
3.20.3-beta.0 MIT
3.1.0-beta.0 MIT
0.10.0-3 MIT
0.10.0-2 MIT
0.10.0-1 MIT