Skip to content

ref: Add --project and --org args to help message and update readme #679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 27, 2024
Merged

ref: Add --project and --org args to help message and update readme #679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b29e2a8
ref: Add `--project` and `--org` args to help message and update readme
Lms24 Sep 26, 2024
00d6c48
changelog
Lms24 Sep 26, 2024
9ba4d94
convert to table
Lms24 Sep 26, 2024
6e74897
.
Lms24 Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Unreleased

- feat: Add `--saas` CLI arg to skip self-hosted or SaaS selection step (#678)
- ref: Add `--project` and `--org` args to help message and update readme (#679)

## 3.31.0

Expand Down
41 changes: 18 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,29 +53,24 @@ At the current moment, the wizard is meant to be used for React Native, Cordova,

# 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/"]
-s, --signup Redirect to signup page if not logged in
Use if don't have a Sentry account [boolean]
```
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

Expand Down
15 changes: 14 additions & 1 deletion bin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,22 @@ const argv = yargs(hideBin(process.argv))
alias: 'url',
describe: 'The url to your Sentry installation\nenv: SENTRY_WIZARD_URL',
})
.option('project', {
type: 'string',
describe: 'The Sentry project slug to use',
defaultDescription: 'Select project during setup',
default: undefined,
})
.option('org', {
type: 'string',
describe: 'The Sentry org slug to use',
defaultDescription: 'Select org during setup',
default: undefined,
})
.option('saas', {
default: false,
describe: 'If set, skip the self-hosted or SaaS URL selection process',
describe: 'Skip the self-hosted or SaaS URL selection process',
defaultDescription: 'Select self-hosted or SaaS during setup',
type: 'boolean',
})
.option('s', {
Expand Down
Loading