Skip to content

getsentry/sentry-wizard

Repository files navigation

Sentry

Sentry Wizard

The Sentry Wizard helps you set up your React Native, Cordova, Electron or Next.js projects with Sentry.

npm version npm dm npm dt Discord Chat

deps deps dev deps peer

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

At the current moment, the wizard is meant to be used for React Native, Cordova, Electron, Next.js, Remix and Sveltekit. 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", "ios", "android", "cordova", "electron", "nextjs", "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

Resources

  • Forum
  • Discord
  • Stack Overflow
  • Twitter Follow