Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/getsentry/sentry-wizard

Sentry Project Setup Wizard
https://github.com/getsentry/sentry-wizard

cordova electron hacktoberfest project react-native sentry tag-production team-web-frontend wizard

Last synced: 5 days ago
JSON representation

Sentry Project Setup Wizard

Host: GitHub
URL: https://github.com/getsentry/sentry-wizard
Owner: getsentry
License: mit
Created: 2017-11-08T18:56:34.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2025-01-14T15:18:03.000Z (8 days ago)
Last Synced: 2025-01-15T03:54:45.376Z (7 days ago)
Topics: cordova, electron, hacktoberfest, project, react-native, sentry, tag-production, team-web-frontend, wizard
Language: TypeScript
Homepage:
Size: 4.96 MB
Stars: 203
Watchers: 51
Forks: 53
Open Issues: 36
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        


  

    

      

      

      

    

  



Sentry Wizard

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


[![npm version](https://img.shields.io/npm/v/@sentry/wizard.svg)](https://www.npmjs.com/package/@sentry/wizard)

[![npm dm](https://img.shields.io/npm/dm/@sentry/wizard.svg)](https://www.npmjs.com/package/@sentry/wizard)

[![npm dt](https://img.shields.io/npm/dt/@sentry/wizard.svg)](https://www.npmjs.com/package/@sentry/wizard)

[![Discord Chat](https://img.shields.io/discord/621778831602221064.svg)](https://discord.gg/Ww9hbqr)

[![deps](https://david-dm.org/getsentry/sentry-wizard/status.svg)](https://david-dm.org/getsentry/sentry-wizard?view=list)

[![deps dev](https://david-dm.org/getsentry/sentry-wizard/dev-status.svg)](https://david-dm.org/getsentry/sentry-wizard?type=dev&view=list)

[![deps peer](https://david-dm.org/getsentry/sentry-wizard/peer-status.svg)](https://david-dm.org/getsentry/sentry-wizard?type=peer&view=list)

![Wizard in action](https://github.com/getsentry/sentry-wizard/raw/master/assets/wizard.mov.gif)

# Usage

There are multiple ways to run the Wizard.

1. Install globally and run it anywhere:

```bash

npm install -g @sentry/wizard

# or

yarn global add @sentry/wizard

sentry-wizard

```

2. Install and run it in your project with `yarn`:

```bash

yarn add @sentry/wizard

yarn sentry-wizard

```

3. Run it directly without installing:

```bash

npx @sentry/wizard

```

At the current moment, the wizard can be used for Next.js, react-native, iOS, 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](https://github.com/getsentry/sentry-wizard/issues)!

# 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", "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`                                 |                                                                                                      |                              |

## Resources

- [![Forum](https://img.shields.io/badge/forum-sentry-green.svg)](https://forum.sentry.io/c/sdks)

- [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/Ww9hbqr)

- [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](http://stackoverflow.com/questions/tagged/sentry)

- [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)