@sentry/wizard

Sentry wizard helping you to configure your project

Usage no npm install needed!

<script type="module">
  import sentryWizard from 'https://cdn.skypack.dev/@sentry/wizard';
</script>

README


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 or Next.js. If you have other platforms you would like the wizard to support, please open a GitHub issue!

Options

Options:
  --help             Show help                                         [boolean]
  --version          Show version number                               [boolean]
  --debug            Enable verbose logging
                     env: SENTRY_WIZARD_DEBUG                          [boolean]
  --uninstall        Revert project set up process
                     env: SENTRY_WIZARD_UNINSTALL                      [boolean]
  --skip-connect     Skips the connection to the server
                     env: SENTRY_WIZARD_SKIP_CONNECT                   [boolean]
  --quiet            Do not fallback to prompting user asking questions
                     env: SENTRY_WIZARD_QUIET                          [boolean]
  -i, --integration  Choose the integration to set up
                     env: SENTRY_WIZARD_INTEGRATION
                       [choices: "reactNative", "cordova", "electron", "nextjs"]
  -p, --platform     Choose platform(s)
                     env: SENTRY_WIZARD_PLATFORM
                                             [array] [choices: "ios", "android"]
  -u, --url          The url to your Sentry installation
                     env: SENTRY_WIZARD_URL      [default: "https://sentry.io/"]

Resources

  • Forum
  • Discord
  • Stack Overflow
  • Twitter Follow