diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index b499857442771..5c89e0f0536d4 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -36,7 +36,7 @@ # /src/docs/product/discover-queries/ @getsentry/visibility # /src/docs/product/performance/ @getsentry/visibility -# /src/docs/product/cli/dif/ @getsentry/owners-native +# /src/docs/cli/dif.mdx @getsentry/owners-native # /.github/labels.yml @getsentry/open-source # /.github/workflows/react-to-product-owners-yml-changes.yml @getsentry/open-source diff --git a/develop-docs/api-server/application-domains/asynchronous-workers.mdx b/develop-docs/api-server/application-domains/asynchronous-workers.mdx index 3cb83e5418a47..5df8328b9bda2 100644 --- a/develop-docs/api-server/application-domains/asynchronous-workers.mdx +++ b/develop-docs/api-server/application-domains/asynchronous-workers.mdx @@ -78,7 +78,7 @@ There are a few important points: ## Running a Worker -Workers can be run by using the [Sentry CLI](https://docs.sentry.io/product/cli/). +Workers can be run by using the [Sentry CLI](https://docs.sentry.io/cli/). ```bash $ sentry run worker diff --git a/docs/account/auth-tokens/index.mdx b/docs/account/auth-tokens/index.mdx index 99df77b16da6d..77ca53dbcd323 100644 --- a/docs/account/auth-tokens/index.mdx +++ b/docs/account/auth-tokens/index.mdx @@ -7,7 +7,7 @@ description: "Learn about the different kinds of Auth Tokens Sentry provides, an Auth tokens (short for _authentication tokens_) are a way to authenticate with Sentry. They are similar to passwords but are designed for programmatic interaction with Sentry. Some examples of what you would use auth tokens for include: - Uploading Source Maps during your CI build -- Using [Sentry CLI](/product/cli/) to interact with Sentry +- Using [Sentry CLI](/cli/) to interact with Sentry - Using the [Sentry API](/api/auth/) Each auth token is created with a certain set of permissions and scopes which are mapped to the Sentry API's [Permissions & Scopes](/api/permissions/). Some types of auth tokens have set permissions that can't be edited, while others can be customized upon token creation and edited later. diff --git a/docs/api/permissions.mdx b/docs/api/permissions.mdx index a72fba015edec..1352aa2d25425 100644 --- a/docs/api/permissions.mdx +++ b/docs/api/permissions.mdx @@ -78,6 +78,6 @@ Events in Sentry are immutable and can only be deleted by deleting the whole iss -Be aware that if you're using `sentry-cli` to [manage your releases](/product/cli/releases/), you'll need a token which also has `org:read` scope. +Be aware that if you're using `sentry-cli` to [manage your releases](/cli/releases/), you'll need a token which also has `org:read` scope. diff --git a/docs/cli/crons.mdx b/docs/cli/crons.mdx index dd285d4cf2074..b49bb88038a5f 100644 --- a/docs/cli/crons.mdx +++ b/docs/cli/crons.mdx @@ -16,7 +16,7 @@ Sentry Crons allows you to monitor the uptime and performance of any scheduled, To begin monitoring your recurring, scheduled job: -- [Install](/product/cli/installation) the Sentry CLI (min v2.16.1). +- [Install](/cli/installation) the Sentry CLI (min v2.16.1). - Create and configure your first Monitor in [Sentry](https://sentry.io/crons/create/) or [via the CLI](#creating-or-updating-a-monitor-through-a-check-in-optional). ## Configuration @@ -36,7 +36,7 @@ Alternatively, you can add it to your `~/.sentryclirc` config: dsn = ___PUBLIC_DSN___ ``` -Learn more about the CLI's [configuration file](/product/cli/configuration#configuration-file). +Learn more about the CLI's [configuration file](/cli/configuration#configuration-file). ## Job Monitoring diff --git a/docs/cli/dif.mdx b/docs/cli/dif.mdx index 67fc3576643a4..29f306e589b63 100644 --- a/docs/cli/dif.mdx +++ b/docs/cli/dif.mdx @@ -16,7 +16,7 @@ The `sentry-cli` requires an [Organization Auth Token](https://sentry.io/orgredi Source maps, while also being debug information files, are handled -differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps). +differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). @@ -101,7 +101,7 @@ for more information. You need to specify the organization and project you are working with because debug information files work on projects. For more information about this refer -to [Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects). +to [Working with Projects](/cli/configuration/#sentry-cli-working-with-projects). @@ -187,7 +187,7 @@ when you only release some of the builds you're creating. You need to specify the organization and project you are working with because ProGuard files work on projects. For more information about this refer to -[Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects). +[Working with Projects](/cli/configuration/#sentry-cli-working-with-projects). @@ -255,7 +255,7 @@ Java or Kotlin. Before you can upload source files, you must configure the Sentry CLI with the organization and project you are uploading bundle files for. See the CLI docs on -[Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects) to learn how to do this. +[Working with Projects](/cli/configuration/#sentry-cli-working-with-projects) to learn how to do this. diff --git a/docs/cli/installation.mdx b/docs/cli/installation.mdx index 4e371805a9e55..9797f684037ef 100644 --- a/docs/cli/installation.mdx +++ b/docs/cli/installation.mdx @@ -105,7 +105,7 @@ If set to `1`, the script will skip downloading the binary completely. `SENTRYCLI_SKIP_CHECKSUM_VALIDATION`: -If set to `1`, the script will skip the checksum validation phase. You can manually verify the checksums by visiting [Build Checksums](/product/cli/installation/#build-checksums) page. +If set to `1`, the script will skip the checksum validation phase. You can manually verify the checksums by visiting [Build Checksums](/cli/installation/#build-checksums) page. `SENTRYCLI_NO_PROGRESS_BAR`: diff --git a/docs/cli/metrics.mdx b/docs/cli/metrics.mdx index 9eb1f8c59bb5c..55e41fd223389 100644 --- a/docs/cli/metrics.mdx +++ b/docs/cli/metrics.mdx @@ -11,7 +11,7 @@ Metrics help you track and visualize the data points you care about, making it e Learn more about [Metrics](/product/explore/metrics). ## Requirements -- [Install](/product/cli/installation) the Sentry CLI (min v2.32.0). +- [Install](/cli/installation) the Sentry CLI (min v2.32.0). ## Configuration diff --git a/docs/cli/releases.mdx b/docs/cli/releases.mdx index 836d5f558f88e..056996d2b75b2 100644 --- a/docs/cli/releases.mdx +++ b/docs/cli/releases.mdx @@ -8,7 +8,7 @@ The `sentry-cli` tool can be used for release management on Sentry. It allows yo -Because releases work on projects you will need to specify the organization and project you are working with. For more information about this refer to [Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects). +Because releases work on projects you will need to specify the organization and project you are working with. For more information about this refer to [Working with Projects](/cli/configuration/#sentry-cli-working-with-projects). diff --git a/docs/cli/send-event.mdx b/docs/cli/send-event.mdx index 55c03fb4c209d..d93fa5f9404f7 100644 --- a/docs/cli/send-event.mdx +++ b/docs/cli/send-event.mdx @@ -110,4 +110,4 @@ eval "$(sentry-cli bash-hook)" # rest of the script goes here ``` -Alternatively you can use other mechanisms like [a `.sentryclirc` file](/product/cli/configuration/#configuration-file) to configure the DSN. +Alternatively you can use other mechanisms like [a `.sentryclirc` file](/cli/configuration/#configuration-file) to configure the DSN. diff --git a/docs/concepts/migration/index.mdx b/docs/concepts/migration/index.mdx index 6a020095344d4..2a932f4f44006 100644 --- a/docs/concepts/migration/index.mdx +++ b/docs/concepts/migration/index.mdx @@ -48,7 +48,7 @@ Below is a non-exhaustive list of some items that will not be relocated: - Issues - Events - Replays and/or other [Event Attachments](/platforms/javascript/enriching-events/attachments/) -- Source Maps, [Debug Information Files](/product/cli/dif/) and/or [Artifact Bundles](/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/) +- Source Maps, [Debug Information Files](/cli/dif/) and/or [Artifact Bundles](/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/) - Release information, including any references to external repositories via specific Pull Requests - Deployment information - Custom Avatars diff --git a/docs/platforms/android/configuration/gradle.mdx b/docs/platforms/android/configuration/gradle.mdx index c833a338e32f1..380579fd53ccc 100644 --- a/docs/platforms/android/configuration/gradle.mdx +++ b/docs/platforms/android/configuration/gradle.mdx @@ -371,7 +371,7 @@ sentry { The plugin will automatically generate appropriate ProGuard mapping files and upload them when you run `gradle assemble{BuildVariant}`. For example, `assembleRelease`. Release is the default, but the plugin works for others as long as you've enabled ProGuard/R8. The credentials for the upload step are defined in the Gradle extension above or loaded from a `sentry.properties` file in your project. -To use Guardsquare's ProGuard or DexGuard tooling, you'll have to enable the `dexguardEnabled` flag. Learn more in the [full `sentry-cli` documentation](/product/cli/configuration/#configuration-values). +To use Guardsquare's ProGuard or DexGuard tooling, you'll have to enable the `dexguardEnabled` flag. Learn more in the [full `sentry-cli` documentation](/cli/configuration/#configuration-values). Instead of providing your credentials via the Gradle extension, you can create a `sentry.properties` file with the following content under your `app` module: @@ -385,7 +385,7 @@ auth.token=___ORG_AUTH_TOKEN___ -You can find your authentication token [on the Organization Auth Tokens](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/) settings page. For more information about the available configuration options, check out the [full sentry-cli documentation](/product/cli/configuration/#configuration-values). +You can find your authentication token [on the Organization Auth Tokens](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/) settings page. For more information about the available configuration options, check out the [full sentry-cli documentation](/cli/configuration/#configuration-values). @@ -393,7 +393,7 @@ You can find your authentication token [on the Organization Auth Tokens](https:/ The plugin will automatically discover and upload Native debug symbols and sources when you run `gradle assemble{BuildVariant}`. The `{BuildVariant}` must be a non-debuggable build type, for example `Release`. The credentials for the upload step are loaded via environment variables or from a `sentry.properties` file in your project root. -Learn more in the [full sentry-cli documentation](/product/cli/configuration/#configuration-values). +Learn more in the [full sentry-cli documentation](/cli/configuration/#configuration-values). At the very minimum, you will need something similar to: @@ -407,7 +407,7 @@ auth.token=___ORG_AUTH_TOKEN___ -You can find your authentication token [on the Sentry API page](https://sentry.io/api/). For more information about the available configuration options, check out the [full sentry-cli documentation](/product/cli/configuration/#configuration-values). +You can find your authentication token [on the Sentry API page](https://sentry.io/api/). For more information about the available configuration options, check out the [full sentry-cli documentation](/cli/configuration/#configuration-values). diff --git a/docs/platforms/android/configuration/releases.mdx b/docs/platforms/android/configuration/releases.mdx index ee4f082dca1c8..755f3d838912e 100644 --- a/docs/platforms/android/configuration/releases.mdx +++ b/docs/platforms/android/configuration/releases.mdx @@ -29,7 +29,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/android/data-management/debug-files/file-formats/index.mdx b/docs/platforms/android/data-management/debug-files/file-formats/index.mdx index 27feac4a0ce65..dd5d74925a8b3 100644 --- a/docs/platforms/android/data-management/debug-files/file-formats/index.mdx +++ b/docs/platforms/android/data-management/debug-files/file-formats/index.mdx @@ -40,7 +40,7 @@ Sentry might not need all of the above information to process crash reports. Still, it is always a good idea to provide all available debug information. `sentry-cli` can be used to list properties of supported debug files and -validate their contents. See [_Debug Information Files in sentry-cli_](/product/cli/dif/) for more information. +validate their contents. See [_Debug Information Files in sentry-cli_](/cli/dif/) for more information. ## Mach-O and dSYM diff --git a/docs/platforms/android/data-management/debug-files/identifiers/index.mdx b/docs/platforms/android/data-management/debug-files/identifiers/index.mdx index 3a704b4c69d3b..aebce9d77c759 100644 --- a/docs/platforms/android/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/android/data-management/debug-files/identifiers/index.mdx @@ -39,7 +39,7 @@ their debug identifiers. You can copy this identifier and search for the exact files that match it in the _Debug Files_ settings screen. `sentry-cli` can help to print properties of debug information files like their -debug identifier. See [_Checking Debug Information Files_](/product/cli/dif/#checking-files) for more information. +debug identifier. See [_Checking Debug Information Files_](/cli/dif/#checking-files) for more information. ## GNU Build Identifiers diff --git a/docs/platforms/android/data-management/debug-files/index.mdx b/docs/platforms/android/data-management/debug-files/index.mdx index 40306c87f6993..b5a401b9febf2 100644 --- a/docs/platforms/android/data-management/debug-files/index.mdx +++ b/docs/platforms/android/data-management/debug-files/index.mdx @@ -27,7 +27,7 @@ the following formats: Source maps, while also being debug information files, are handled -differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps). +differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). diff --git a/docs/platforms/android/data-management/debug-files/source-context/index.mdx b/docs/platforms/android/data-management/debug-files/source-context/index.mdx index 973aefa65b3e7..17447f9a423a8 100644 --- a/docs/platforms/android/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/android/data-management/debug-files/source-context/index.mdx @@ -18,7 +18,7 @@ because they have access to unobfuscated source code at runtime. By contrast, to get source context for compiled applications, the source code needs to be uploaded alongside the debug information files. The recommended way to do this is by using `sentry-cli`. -See [Creating Source Bundles](/product/cli/dif/#creating-source-bundles) for more information. +See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information. diff --git a/docs/platforms/android/enhance-errors/proguard.mdx b/docs/platforms/android/enhance-errors/proguard.mdx index f96396087a893..5a022d7739838 100644 --- a/docs/platforms/android/enhance-errors/proguard.mdx +++ b/docs/platforms/android/enhance-errors/proguard.mdx @@ -4,7 +4,7 @@ sidebar_order: 100 description: "Learn about using the Sentry Gradle Plugin or sentry-cli to upload ProGuard/R8 and DexGuard mappings to Sentry." --- -If you want to see de-obfuscated stack traces, you'll need to use [ProGuard](https://www.guardsquare.com/proguard) with Sentry. To do so, upload the ProGuard mapping files by either the recommended method of using our [Gradle integration](/platforms/android/configuration/gradle/) or manually by using [sentry-cli](/product/cli/dif/#proguard-mapping-upload). +If you want to see de-obfuscated stack traces, you'll need to use [ProGuard](https://www.guardsquare.com/proguard) with Sentry. To do so, upload the ProGuard mapping files by either the recommended method of using our [Gradle integration](/platforms/android/configuration/gradle/) or manually by using [sentry-cli](/cli/dif/#proguard-mapping-upload). It works the same either way. A (random) UUID will be or has to be generated and placed into the `AndroidManifest.xml`. The same UUID has to be used to upload the mapping file(s). In case a crash happens in the app, the Sentry Android SDK will send the UUID along with the stack trace to the Sentry server instance. Sentry will then de-obfuscate the stack trace by searching for the associated mapping file with the same UUID. diff --git a/docs/platforms/android/migration/index.mdx b/docs/platforms/android/migration/index.mdx index ad018851f8831..97f22f4ec9312 100644 --- a/docs/platforms/android/migration/index.mdx +++ b/docs/platforms/android/migration/index.mdx @@ -171,7 +171,7 @@ The `io.sentry.android.gradle` >= `3.0.0` requires [Android Gradle Plugin >= 7.0 The `autoUpload` flag has been deprecated in favor of two new options: -- `includeProguardMapping` - Disables/enables Proguard mapping functionality. When enabled, generates a UUID and attempts to upload a Proguard mapping associated with that UUID to Sentry. When `autoUploadProguardMapping` is disabled, the plugin will only generate a `sentry-debug-meta.properties` file containing UUID, which can later be used to manually upload the mapping using, for example [sentry-cli](/product/cli/dif/#proguard-mapping-upload). +- `includeProguardMapping` - Disables/enables Proguard mapping functionality. When enabled, generates a UUID and attempts to upload a Proguard mapping associated with that UUID to Sentry. When `autoUploadProguardMapping` is disabled, the plugin will only generate a `sentry-debug-meta.properties` file containing UUID, which can later be used to manually upload the mapping using, for example [sentry-cli](/cli/dif/#proguard-mapping-upload). - `autoUploadProguardMapping` - Defines whether the gradle plugin should attempt to auto-upload the mapping file to Sentry. When `includeProguardMapping` is disabled, this flag has no effect. diff --git a/docs/platforms/android/troubleshooting/index.mdx b/docs/platforms/android/troubleshooting/index.mdx index d20413e62ff4a..acdf97c92ad73 100644 --- a/docs/platforms/android/troubleshooting/index.mdx +++ b/docs/platforms/android/troubleshooting/index.mdx @@ -181,7 +181,7 @@ android.bundle.enableUncompressedNativeLibs=false ### Proguard Mapping Upload Issues -You can set the debug log flag as an environment variable, which is picked up by the [Sentry CLI](/product/cli/). +You can set the debug log flag as an environment variable, which is picked up by the [Sentry CLI](/cli/). In addition, set the `--stacktrace` flag: ``` diff --git a/docs/platforms/apple/common/configuration/releases.mdx b/docs/platforms/apple/common/configuration/releases.mdx index 9452a9f9a258a..8d466776a0610 100644 --- a/docs/platforms/apple/common/configuration/releases.mdx +++ b/docs/platforms/apple/common/configuration/releases.mdx @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/apple/common/data-management/debug-files/file-formats/index.mdx b/docs/platforms/apple/common/data-management/debug-files/file-formats/index.mdx index 65a23118e1d85..21f4f8b7ed485 100644 --- a/docs/platforms/apple/common/data-management/debug-files/file-formats/index.mdx +++ b/docs/platforms/apple/common/data-management/debug-files/file-formats/index.mdx @@ -40,7 +40,7 @@ Sentry might not need all of the above information to process crash reports. Still, it is always a good idea to provide all available debug information. `sentry-cli` can be used to list properties of supported debug files and -validate their contents. See [_Debug Information Files in sentry-cli_](/product/cli/dif/) for more information. +validate their contents. See [_Debug Information Files in sentry-cli_](/cli/dif/) for more information. ## Mach-O and dSYM diff --git a/docs/platforms/apple/common/data-management/debug-files/identifiers/index.mdx b/docs/platforms/apple/common/data-management/debug-files/identifiers/index.mdx index 3a704b4c69d3b..aebce9d77c759 100644 --- a/docs/platforms/apple/common/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/apple/common/data-management/debug-files/identifiers/index.mdx @@ -39,7 +39,7 @@ their debug identifiers. You can copy this identifier and search for the exact files that match it in the _Debug Files_ settings screen. `sentry-cli` can help to print properties of debug information files like their -debug identifier. See [_Checking Debug Information Files_](/product/cli/dif/#checking-files) for more information. +debug identifier. See [_Checking Debug Information Files_](/cli/dif/#checking-files) for more information. ## GNU Build Identifiers diff --git a/docs/platforms/apple/common/data-management/debug-files/index.mdx b/docs/platforms/apple/common/data-management/debug-files/index.mdx index 40306c87f6993..b5a401b9febf2 100644 --- a/docs/platforms/apple/common/data-management/debug-files/index.mdx +++ b/docs/platforms/apple/common/data-management/debug-files/index.mdx @@ -27,7 +27,7 @@ the following formats: Source maps, while also being debug information files, are handled -differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps). +differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). diff --git a/docs/platforms/apple/common/data-management/debug-files/source-context/index.mdx b/docs/platforms/apple/common/data-management/debug-files/source-context/index.mdx index a1524d6e8fdfc..72ab6e575ff09 100644 --- a/docs/platforms/apple/common/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/apple/common/data-management/debug-files/source-context/index.mdx @@ -18,7 +18,7 @@ because they have access to unobfuscated source code at runtime. By contrast, to get source context for compiled applications, the source code needs to be uploaded alongside the debug information files. The recommended way to do this is by using `sentry-cli`. -See [Creating Source Bundles](/product/cli/dif/#creating-source-bundles) for more information. +See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information. To get source context for your Apple project, follow the instructions in the [Uploading Debug Symbols](/platforms/apple/sourcecontext) guide. diff --git a/docs/platforms/dart/configuration/releases.mdx b/docs/platforms/dart/configuration/releases.mdx index c25bf6ca359a0..da74a0d318c8f 100644 --- a/docs/platforms/dart/configuration/releases.mdx +++ b/docs/platforms/dart/configuration/releases.mdx @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/dotnet/common/configuration/msbuild.mdx b/docs/platforms/dotnet/common/configuration/msbuild.mdx index 00b8bc645dcf2..1380235fc2054 100644 --- a/docs/platforms/dotnet/common/configuration/msbuild.mdx +++ b/docs/platforms/dotnet/common/configuration/msbuild.mdx @@ -4,8 +4,8 @@ description: "Configure MSBuild properties in your .NET project to automatically sidebar_order: 10 --- -The [Sentry CLI](/product/cli) has many useful features that can improve your Sentry experience. -For .NET, you can use it to upload [debug information files](/product/cli/dif), such as .NET `PDB` symbol files. +The [Sentry CLI](/cli) has many useful features that can improve your Sentry experience. +For .NET, you can use it to upload [debug information files](/cli/dif), such as .NET `PDB` symbol files. This allows Sentry to show a more complete stack trace, including file names and line numbers. You can also use it to upload _source code_, which enables Sentry to display [source context](../../data-management/debug-files/source-context/) when viewing stack traces. @@ -24,11 +24,11 @@ or use it in any way that it would be written to log files. -Any of the authentication methods accepted by the Sentry CLI can be used. See [Configuration and Authentication](/product/cli/configuration/). +Any of the authentication methods accepted by the Sentry CLI can be used. See [Configuration and Authentication](/cli/configuration/). However, we generally recommend the following: -- If building your releases on a developer workstation, [install the Sentry CLI](/product/cli/installation/) and then - call `sentry-cli login` to use the [automatic configuration](/product/cli/configuration/#to-use-the-automatic-option) option. +- If building your releases on a developer workstation, [install the Sentry CLI](/cli/installation/) and then + call `sentry-cli login` to use the [automatic configuration](/cli/configuration/#to-use-the-automatic-option) option. This will help you create an auth token and save it to the `~/.sentryclirc` file on the workstation. - If building from a CI/CD server, use the secrets feature of your CI/CD platform to set the `SENTRY_AUTH_TOKEN` environment variable. @@ -61,7 +61,7 @@ If you are self-hosting Sentry (rather than using sentry.io), then you will also -Any of the [Sentry CLI configuration values](/product/cli/configuration/#configuration-values) can be set via environment variables +Any of the [Sentry CLI configuration values](/cli/configuration/#configuration-values) can be set via environment variables or in configuration files, such as shown in the above authentication steps. However, other than authentication, you should consider setting configuration values via the MSBuild properties described below, diff --git a/docs/platforms/dotnet/common/configuration/releases.mdx b/docs/platforms/dotnet/common/configuration/releases.mdx index de3f8f6326370..43f8984dc810b 100644 --- a/docs/platforms/dotnet/common/configuration/releases.mdx +++ b/docs/platforms/dotnet/common/configuration/releases.mdx @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/dotnet/common/data-management/debug-files/file-formats/index.mdx b/docs/platforms/dotnet/common/data-management/debug-files/file-formats/index.mdx index 65a23118e1d85..21f4f8b7ed485 100644 --- a/docs/platforms/dotnet/common/data-management/debug-files/file-formats/index.mdx +++ b/docs/platforms/dotnet/common/data-management/debug-files/file-formats/index.mdx @@ -40,7 +40,7 @@ Sentry might not need all of the above information to process crash reports. Still, it is always a good idea to provide all available debug information. `sentry-cli` can be used to list properties of supported debug files and -validate their contents. See [_Debug Information Files in sentry-cli_](/product/cli/dif/) for more information. +validate their contents. See [_Debug Information Files in sentry-cli_](/cli/dif/) for more information. ## Mach-O and dSYM diff --git a/docs/platforms/dotnet/common/data-management/debug-files/identifiers/index.mdx b/docs/platforms/dotnet/common/data-management/debug-files/identifiers/index.mdx index 3a704b4c69d3b..aebce9d77c759 100644 --- a/docs/platforms/dotnet/common/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/dotnet/common/data-management/debug-files/identifiers/index.mdx @@ -39,7 +39,7 @@ their debug identifiers. You can copy this identifier and search for the exact files that match it in the _Debug Files_ settings screen. `sentry-cli` can help to print properties of debug information files like their -debug identifier. See [_Checking Debug Information Files_](/product/cli/dif/#checking-files) for more information. +debug identifier. See [_Checking Debug Information Files_](/cli/dif/#checking-files) for more information. ## GNU Build Identifiers diff --git a/docs/platforms/dotnet/common/data-management/debug-files/index.mdx b/docs/platforms/dotnet/common/data-management/debug-files/index.mdx index 40306c87f6993..b5a401b9febf2 100644 --- a/docs/platforms/dotnet/common/data-management/debug-files/index.mdx +++ b/docs/platforms/dotnet/common/data-management/debug-files/index.mdx @@ -27,7 +27,7 @@ the following formats: Source maps, while also being debug information files, are handled -differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps). +differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). diff --git a/docs/platforms/dotnet/common/data-management/debug-files/source-context/index.mdx b/docs/platforms/dotnet/common/data-management/debug-files/source-context/index.mdx index 489d360850ef7..52e3fd63e7874 100644 --- a/docs/platforms/dotnet/common/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/dotnet/common/data-management/debug-files/source-context/index.mdx @@ -18,7 +18,7 @@ because they have access to unobfuscated source code at runtime. By contrast, to get source context for compiled applications, the source code needs to be uploaded alongside the debug information files. The recommended way to do this is by using `sentry-cli`. -See [Creating Source Bundles](/product/cli/dif/#creating-source-bundles) for more information. +See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information. diff --git a/docs/platforms/elixir/configuration/releases.mdx b/docs/platforms/elixir/configuration/releases.mdx index 35d472a60df93..babb58d14dcbd 100644 --- a/docs/platforms/elixir/configuration/releases.mdx +++ b/docs/platforms/elixir/configuration/releases.mdx @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/flutter/configuration/releases.mdx b/docs/platforms/flutter/configuration/releases.mdx index 22093a18faee8..7e60fca65b402 100644 --- a/docs/platforms/flutter/configuration/releases.mdx +++ b/docs/platforms/flutter/configuration/releases.mdx @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/flutter/data-management/debug-files/file-formats/index.mdx b/docs/platforms/flutter/data-management/debug-files/file-formats/index.mdx index 27feac4a0ce65..dd5d74925a8b3 100644 --- a/docs/platforms/flutter/data-management/debug-files/file-formats/index.mdx +++ b/docs/platforms/flutter/data-management/debug-files/file-formats/index.mdx @@ -40,7 +40,7 @@ Sentry might not need all of the above information to process crash reports. Still, it is always a good idea to provide all available debug information. `sentry-cli` can be used to list properties of supported debug files and -validate their contents. See [_Debug Information Files in sentry-cli_](/product/cli/dif/) for more information. +validate their contents. See [_Debug Information Files in sentry-cli_](/cli/dif/) for more information. ## Mach-O and dSYM diff --git a/docs/platforms/flutter/data-management/debug-files/identifiers/index.mdx b/docs/platforms/flutter/data-management/debug-files/identifiers/index.mdx index 3a704b4c69d3b..aebce9d77c759 100644 --- a/docs/platforms/flutter/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/flutter/data-management/debug-files/identifiers/index.mdx @@ -39,7 +39,7 @@ their debug identifiers. You can copy this identifier and search for the exact files that match it in the _Debug Files_ settings screen. `sentry-cli` can help to print properties of debug information files like their -debug identifier. See [_Checking Debug Information Files_](/product/cli/dif/#checking-files) for more information. +debug identifier. See [_Checking Debug Information Files_](/cli/dif/#checking-files) for more information. ## GNU Build Identifiers diff --git a/docs/platforms/flutter/data-management/debug-files/index.mdx b/docs/platforms/flutter/data-management/debug-files/index.mdx index 40306c87f6993..b5a401b9febf2 100644 --- a/docs/platforms/flutter/data-management/debug-files/index.mdx +++ b/docs/platforms/flutter/data-management/debug-files/index.mdx @@ -27,7 +27,7 @@ the following formats: Source maps, while also being debug information files, are handled -differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps). +differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). diff --git a/docs/platforms/flutter/data-management/debug-files/source-context/index.mdx b/docs/platforms/flutter/data-management/debug-files/source-context/index.mdx index f323829d10842..0e3997027df09 100644 --- a/docs/platforms/flutter/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/flutter/data-management/debug-files/source-context/index.mdx @@ -18,7 +18,7 @@ because they have access to unobfuscated source code at runtime. By contrast, to get source context for compiled applications, the source code needs to be uploaded alongside the debug information files. The recommended way to do this is by using `sentry-cli`. -See [Creating Source Bundles](/product/cli/dif/#creating-source-bundles) for more information. +See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information. diff --git a/docs/platforms/flutter/upload-debug.mdx b/docs/platforms/flutter/upload-debug.mdx index 286d84e322e60..088c0d6d478c9 100644 --- a/docs/platforms/flutter/upload-debug.mdx +++ b/docs/platforms/flutter/upload-debug.mdx @@ -171,11 +171,11 @@ Sentry's Flutter SDK doesn't currently support the `uploadNativeSymbols` flag fr ### Uploading with ProGuard -If you have ProGuard (`minifyEnabled`) enabled, you must upload the [Android Proguard/R8 mapping files](/platforms/android/enhance-errors/proguard/) to see complete stack traces. You can upload these files by either using our Gradle integration (recommended) or manually by using the [Sentry CLI](/product/cli/dif/#proguard-mapping-upload). +If you have ProGuard (`minifyEnabled`) enabled, you must upload the [Android Proguard/R8 mapping files](/platforms/android/enhance-errors/proguard/) to see complete stack traces. You can upload these files by either using our Gradle integration (recommended) or manually by using the [Sentry CLI](/cli/dif/#proguard-mapping-upload). ### Uploading Source Maps for Flutter Web -The Sentry Dart plugin also uploads source maps if `upload_source_maps` is enabled. Alternatively, you can use the Sentry CLI to upload your source maps for Flutter Web by following the docs on [Managing Release Artifacts](/product/cli/releases/#managing-release-artifacts). +The Sentry Dart plugin also uploads source maps if `upload_source_maps` is enabled. Alternatively, you can use the Sentry CLI to upload your source maps for Flutter Web by following the docs on [Managing Release Artifacts](/cli/releases/#managing-release-artifacts). ### Uploading Source Context diff --git a/docs/platforms/go/common/configuration/releases.mdx b/docs/platforms/go/common/configuration/releases.mdx index 35d472a60df93..babb58d14dcbd 100644 --- a/docs/platforms/go/common/configuration/releases.mdx +++ b/docs/platforms/go/common/configuration/releases.mdx @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/java/common/configuration/releases.mdx b/docs/platforms/java/common/configuration/releases.mdx index 19498737a1f6a..bbf6336dae8e6 100644 --- a/docs/platforms/java/common/configuration/releases.mdx +++ b/docs/platforms/java/common/configuration/releases.mdx @@ -29,7 +29,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/javascript/common/configuration/releases.mdx b/docs/platforms/javascript/common/configuration/releases.mdx index ee4f082dca1c8..755f3d838912e 100644 --- a/docs/platforms/javascript/common/configuration/releases.mdx +++ b/docs/platforms/javascript/common/configuration/releases.mdx @@ -29,7 +29,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/javascript/common/data-management/debug-files/file-formats/index.mdx b/docs/platforms/javascript/common/data-management/debug-files/file-formats/index.mdx index c7287c3a3b8b6..fac5e7d6321ee 100644 --- a/docs/platforms/javascript/common/data-management/debug-files/file-formats/index.mdx +++ b/docs/platforms/javascript/common/data-management/debug-files/file-formats/index.mdx @@ -43,7 +43,7 @@ Sentry might not need all of the above information to process crash reports. Still, it is always a good idea to provide all available debug information. `sentry-cli` can be used to list properties of supported debug files and -validate their contents. See [_Debug Information Files in sentry-cli_](/product/cli/dif/) for more information. +validate their contents. See [_Debug Information Files in sentry-cli_](/cli/dif/) for more information. ## Mach-O and dSYM diff --git a/docs/platforms/javascript/common/data-management/debug-files/identifiers/index.mdx b/docs/platforms/javascript/common/data-management/debug-files/identifiers/index.mdx index 9036f98e19f9c..20115c925e77e 100644 --- a/docs/platforms/javascript/common/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/javascript/common/data-management/debug-files/identifiers/index.mdx @@ -42,7 +42,7 @@ their debug identifiers. You can copy this identifier and search for the exact files that match it in the _Debug Files_ settings screen. `sentry-cli` can help to print properties of debug information files like their -debug identifier. See [_Checking Debug Information Files_](/product/cli/dif/#checking-files) for more information. +debug identifier. See [_Checking Debug Information Files_](/cli/dif/#checking-files) for more information. ## GNU Build Identifiers diff --git a/docs/platforms/javascript/common/data-management/debug-files/index.mdx b/docs/platforms/javascript/common/data-management/debug-files/index.mdx index 49c9a05e5dbcd..f2806f21db4bd 100644 --- a/docs/platforms/javascript/common/data-management/debug-files/index.mdx +++ b/docs/platforms/javascript/common/data-management/debug-files/index.mdx @@ -30,7 +30,7 @@ the following formats: Source maps, while also being debug information files, are handled -differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps). +differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). diff --git a/docs/platforms/javascript/common/data-management/debug-files/source-context/index.mdx b/docs/platforms/javascript/common/data-management/debug-files/source-context/index.mdx index 6ddd39c5c62b8..14b697d6059e5 100644 --- a/docs/platforms/javascript/common/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/javascript/common/data-management/debug-files/source-context/index.mdx @@ -21,7 +21,7 @@ because they have access to unobfuscated source code at runtime. By contrast, to get source context for compiled applications, the source code needs to be uploaded alongside the debug information files. The recommended way to do this is by using `sentry-cli`. -See [Creating Source Bundles](/product/cli/dif/#creating-source-bundles) for more information. +See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information. After they've been uploaded you can review and manage source bundles the same as any other debug information file. See [Managing Debug Information Files](../#managing-debug-information-files). diff --git a/docs/platforms/javascript/common/sourcemaps/index.mdx b/docs/platforms/javascript/common/sourcemaps/index.mdx index 0598ac72cf66b..c4c85870c8e16 100644 --- a/docs/platforms/javascript/common/sourcemaps/index.mdx +++ b/docs/platforms/javascript/common/sourcemaps/index.mdx @@ -10,6 +10,6 @@ description: "Learn how to enable readable stack traces in your Sentry errors." ## Additional Resources -- [Using sentry-cli to Upload Source Maps](/product/cli/releases/#sentry-cli-sourcemaps) +- [Using sentry-cli to Upload Source Maps](/cli/releases/#sentry-cli-sourcemaps) - [4 Reasons Why Your Source Maps Are Broken](https://blog.sentry.io/2018/10/18/4-reasons-why-your-source-maps-are-broken) - [Debug Your Node.js Projects with Source Maps](https://blog.sentry.io/2019/02/20/debug-node-source-maps) diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/create-react-app.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/create-react-app.mdx index 90034f8ea1f5b..e1bbfb041eed1 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/create-react-app.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/create-react-app.mdx @@ -47,7 +47,7 @@ pnpm add @sentry/cli --save-dev -For more info on `sentry-cli` configuration visit the [Sentry CLI configuration docs](/product/cli/configuration/). +For more info on `sentry-cli` configuration visit the [Sentry CLI configuration docs](/cli/configuration/). diff --git a/docs/platforms/javascript/guides/electron/index.mdx b/docs/platforms/javascript/guides/electron/index.mdx index 23c8fa9968232..181dff6ebc950 100644 --- a/docs/platforms/javascript/guides/electron/index.mdx +++ b/docs/platforms/javascript/guides/electron/index.mdx @@ -225,7 +225,7 @@ If your application contains custom native extensions or you wish to symbolicate crashes from a spawned child process, upload their debug information manually during your build or release process. See [_Debug Information Files_](/platforms/javascript/guides/electron/data-management/debug-files/) for a detailed description of how to set up Sentry for native development. Additionally, see [_Uploading Debug -Information_](/product/cli/dif/) for the upload process. +Information_](/cli/dif/) for the upload process. ### Child Processes diff --git a/docs/platforms/javascript/legacy-sdk/sourcemaps.mdx b/docs/platforms/javascript/legacy-sdk/sourcemaps.mdx index 9fbf9f70ef338..251b0e8c9c072 100644 --- a/docs/platforms/javascript/legacy-sdk/sourcemaps.mdx +++ b/docs/platforms/javascript/legacy-sdk/sourcemaps.mdx @@ -20,7 +20,7 @@ Most of the process is the same whether you're using this SDK or the [new unifie ## Specify the release in Raven.js -If you are uploading source map artifacts yourself, you must specify the release in your Raven.js client configuration. Sentry will use the release name to associate digested event data with the files you’ve uploaded via the [releases API](/api/releases/), [sentry-cli](/product/cli/) or [sentry-webpack-plugin](https://github.com/getsentry/sentry-webpack-plugin). This step is optional if you are hosting source maps on the remote server, but still recommended. +If you are uploading source map artifacts yourself, you must specify the release in your Raven.js client configuration. Sentry will use the release name to associate digested event data with the files you’ve uploaded via the [releases API](/api/releases/), [sentry-cli](/cli/) or [sentry-webpack-plugin](https://github.com/getsentry/sentry-webpack-plugin). This step is optional if you are hosting source maps on the remote server, but still recommended. ```javascript Raven.config("your-dsn", { diff --git a/docs/platforms/kotlin-multiplatform/configuration/releases.mdx b/docs/platforms/kotlin-multiplatform/configuration/releases.mdx index 4e260d2104e22..5ebdfaf5227d7 100644 --- a/docs/platforms/kotlin-multiplatform/configuration/releases.mdx +++ b/docs/platforms/kotlin-multiplatform/configuration/releases.mdx @@ -29,7 +29,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/native/common/configuration/releases.mdx b/docs/platforms/native/common/configuration/releases.mdx index 9452a9f9a258a..8d466776a0610 100644 --- a/docs/platforms/native/common/configuration/releases.mdx +++ b/docs/platforms/native/common/configuration/releases.mdx @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/native/common/data-management/debug-files/file-formats/index.mdx b/docs/platforms/native/common/data-management/debug-files/file-formats/index.mdx index 9eb297cc2a983..feab4c5c27041 100644 --- a/docs/platforms/native/common/data-management/debug-files/file-formats/index.mdx +++ b/docs/platforms/native/common/data-management/debug-files/file-formats/index.mdx @@ -40,7 +40,7 @@ Sentry might not need all of the above information to process crash reports. Still, it is always a good idea to provide all available debug information. `sentry-cli` can be used to list properties of supported debug files and -validate their contents. See [_Debug Information Files in sentry-cli_](/product/cli/dif/) for more information. +validate their contents. See [_Debug Information Files in sentry-cli_](/cli/dif/) for more information. diff --git a/docs/platforms/native/common/data-management/debug-files/identifiers/index.mdx b/docs/platforms/native/common/data-management/debug-files/identifiers/index.mdx index b59fa2955eb22..a4ce5da0fdf22 100644 --- a/docs/platforms/native/common/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/native/common/data-management/debug-files/identifiers/index.mdx @@ -39,7 +39,7 @@ their debug identifiers. You can copy this identifier and search for the exact files that match it in the _Debug Files_ settings screen. `sentry-cli` can help to print properties of debug information files like their -debug identifier. See [_Checking Debug Information Files_](/product/cli/dif/#checking-files) for more information. +debug identifier. See [_Checking Debug Information Files_](/cli/dif/#checking-files) for more information. diff --git a/docs/platforms/native/common/data-management/debug-files/index.mdx b/docs/platforms/native/common/data-management/debug-files/index.mdx index a3a2f4e61b28f..0876114bc0b4c 100644 --- a/docs/platforms/native/common/data-management/debug-files/index.mdx +++ b/docs/platforms/native/common/data-management/debug-files/index.mdx @@ -15,7 +15,7 @@ can use some of this information and display it on the issue details page. Source maps, while also being debug information files, are handled -differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps). +differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). diff --git a/docs/platforms/native/common/data-management/debug-files/source-context/index.mdx b/docs/platforms/native/common/data-management/debug-files/source-context/index.mdx index 4d80a865c7908..1c63560f80572 100644 --- a/docs/platforms/native/common/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/native/common/data-management/debug-files/source-context/index.mdx @@ -18,7 +18,7 @@ because they have access to unobfuscated source code at runtime. By contrast, to get source context for compiled applications, the source code needs to be uploaded alongside the debug information files. The recommended way to do this is by using `sentry-cli`. -See [Creating Source Bundles](/product/cli/dif/#creating-source-bundles) for more information. +See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information. After they've been uploaded you can review and manage source bundles the same as any other debug information file. See [Managing Debug Information Files](../#managing-debug-information-files). diff --git a/docs/platforms/php/common/configuration/releases.mdx b/docs/platforms/php/common/configuration/releases.mdx index 35d472a60df93..babb58d14dcbd 100644 --- a/docs/platforms/php/common/configuration/releases.mdx +++ b/docs/platforms/php/common/configuration/releases.mdx @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/powershell/configuration/releases.mdx b/docs/platforms/powershell/configuration/releases.mdx index c0cd837dee5b0..bde5894a2e303 100644 --- a/docs/platforms/powershell/configuration/releases.mdx +++ b/docs/platforms/powershell/configuration/releases.mdx @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app - `version` is the semver-like structure `...-` - `build` is the number that identifies an iteration of your app -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/react-native/configuration/releases.mdx b/docs/platforms/react-native/configuration/releases.mdx index ee4f082dca1c8..755f3d838912e 100644 --- a/docs/platforms/react-native/configuration/releases.mdx +++ b/docs/platforms/react-native/configuration/releases.mdx @@ -29,7 +29,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/react-native/data-management/debug-files/file-formats/index.mdx b/docs/platforms/react-native/data-management/debug-files/file-formats/index.mdx index 27feac4a0ce65..dd5d74925a8b3 100644 --- a/docs/platforms/react-native/data-management/debug-files/file-formats/index.mdx +++ b/docs/platforms/react-native/data-management/debug-files/file-formats/index.mdx @@ -40,7 +40,7 @@ Sentry might not need all of the above information to process crash reports. Still, it is always a good idea to provide all available debug information. `sentry-cli` can be used to list properties of supported debug files and -validate their contents. See [_Debug Information Files in sentry-cli_](/product/cli/dif/) for more information. +validate their contents. See [_Debug Information Files in sentry-cli_](/cli/dif/) for more information. ## Mach-O and dSYM diff --git a/docs/platforms/react-native/data-management/debug-files/identifiers/index.mdx b/docs/platforms/react-native/data-management/debug-files/identifiers/index.mdx index 3a704b4c69d3b..aebce9d77c759 100644 --- a/docs/platforms/react-native/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/react-native/data-management/debug-files/identifiers/index.mdx @@ -39,7 +39,7 @@ their debug identifiers. You can copy this identifier and search for the exact files that match it in the _Debug Files_ settings screen. `sentry-cli` can help to print properties of debug information files like their -debug identifier. See [_Checking Debug Information Files_](/product/cli/dif/#checking-files) for more information. +debug identifier. See [_Checking Debug Information Files_](/cli/dif/#checking-files) for more information. ## GNU Build Identifiers diff --git a/docs/platforms/react-native/data-management/debug-files/index.mdx b/docs/platforms/react-native/data-management/debug-files/index.mdx index 40306c87f6993..b5a401b9febf2 100644 --- a/docs/platforms/react-native/data-management/debug-files/index.mdx +++ b/docs/platforms/react-native/data-management/debug-files/index.mdx @@ -27,7 +27,7 @@ the following formats: Source maps, while also being debug information files, are handled -differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps). +differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). diff --git a/docs/platforms/react-native/data-management/debug-files/source-context/index.mdx b/docs/platforms/react-native/data-management/debug-files/source-context/index.mdx index 74354df398a42..54e5343bf41bf 100644 --- a/docs/platforms/react-native/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/react-native/data-management/debug-files/source-context/index.mdx @@ -18,7 +18,7 @@ because they have access to unobfuscated source code at runtime. By contrast, to get source context for compiled applications, the source code needs to be uploaded alongside the debug information files. The recommended way to do this is by using `sentry-cli`. -See [Creating Source Bundles](/product/cli/dif/#creating-source-bundles) for more information. +See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information. To get source context for React Native JavaScript code, follow the instructions in the [Source Maps](/platforms/react-native/sourcemaps/) guide. For native Android and iOS code, follow the instructions in the [Debug Symbols](/platforms/react-native/upload-debug/) guide. diff --git a/docs/platforms/react-native/sourcemaps/troubleshooting/legacy-uploading-methods.mdx b/docs/platforms/react-native/sourcemaps/troubleshooting/legacy-uploading-methods.mdx index aa5254946916e..22a2d5a5cfbeb 100644 --- a/docs/platforms/react-native/sourcemaps/troubleshooting/legacy-uploading-methods.mdx +++ b/docs/platforms/react-native/sourcemaps/troubleshooting/legacy-uploading-methods.mdx @@ -12,7 +12,7 @@ You need to generate and upload the source maps at build time for **every releas ### 1. Configure CLI -Configure the CLI by reviewing the [configuration guide](/product/cli/configuration/) for CLI commands. +Configure the CLI by reviewing the [configuration guide](/cli/configuration/) for CLI commands. ### 2. Generate the bundle and source maps diff --git a/docs/platforms/react-native/upload-debug/index.mdx b/docs/platforms/react-native/upload-debug/index.mdx index 38aabca70b85a..9c0fe032445f0 100644 --- a/docs/platforms/react-native/upload-debug/index.mdx +++ b/docs/platforms/react-native/upload-debug/index.mdx @@ -24,7 +24,7 @@ To upload native iOS debug symbols, set up a Run Script build phase for uploadin ## Uploading With sentry-cli -Upload the [Android ProGuard/R8 mapping files and native symbols](/product/cli/) manually by using `sentry-cli` [upload-proguard](/product/cli/dif/#proguard-mapping-upload) and [debug-files](/cli/dif/#uploading-files). +Upload the [Android ProGuard/R8 mapping files and native symbols](/cli/) manually by using `sentry-cli` [upload-proguard](/cli/dif/#proguard-mapping-upload) and [debug-files](/cli/dif/#uploading-files). ## Uploading Source Context With Sentry Gradle Plugin diff --git a/docs/platforms/ruby/common/configuration/releases.mdx b/docs/platforms/ruby/common/configuration/releases.mdx index f16a96655daa9..0d6bf7aa1a530 100644 --- a/docs/platforms/ruby/common/configuration/releases.mdx +++ b/docs/platforms/ruby/common/configuration/releases.mdx @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/rust/common/configuration/releases.mdx b/docs/platforms/rust/common/configuration/releases.mdx index ed5b997ca6937..31f467ea6c5e5 100644 --- a/docs/platforms/rust/common/configuration/releases.mdx +++ b/docs/platforms/rust/common/configuration/releases.mdx @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/unity/configuration/releases.mdx b/docs/platforms/unity/configuration/releases.mdx index 2d6cc768fba28..d36327936dd7e 100644 --- a/docs/platforms/unity/configuration/releases.mdx +++ b/docs/platforms/unity/configuration/releases.mdx @@ -33,7 +33,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/unity/data-management/debug-files/file-formats/index.mdx b/docs/platforms/unity/data-management/debug-files/file-formats/index.mdx index 65a23118e1d85..21f4f8b7ed485 100644 --- a/docs/platforms/unity/data-management/debug-files/file-formats/index.mdx +++ b/docs/platforms/unity/data-management/debug-files/file-formats/index.mdx @@ -40,7 +40,7 @@ Sentry might not need all of the above information to process crash reports. Still, it is always a good idea to provide all available debug information. `sentry-cli` can be used to list properties of supported debug files and -validate their contents. See [_Debug Information Files in sentry-cli_](/product/cli/dif/) for more information. +validate their contents. See [_Debug Information Files in sentry-cli_](/cli/dif/) for more information. ## Mach-O and dSYM diff --git a/docs/platforms/unity/data-management/debug-files/identifiers/index.mdx b/docs/platforms/unity/data-management/debug-files/identifiers/index.mdx index 3a704b4c69d3b..aebce9d77c759 100644 --- a/docs/platforms/unity/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/unity/data-management/debug-files/identifiers/index.mdx @@ -39,7 +39,7 @@ their debug identifiers. You can copy this identifier and search for the exact files that match it in the _Debug Files_ settings screen. `sentry-cli` can help to print properties of debug information files like their -debug identifier. See [_Checking Debug Information Files_](/product/cli/dif/#checking-files) for more information. +debug identifier. See [_Checking Debug Information Files_](/cli/dif/#checking-files) for more information. ## GNU Build Identifiers diff --git a/docs/platforms/unity/data-management/debug-files/index.mdx b/docs/platforms/unity/data-management/debug-files/index.mdx index 40306c87f6993..b5a401b9febf2 100644 --- a/docs/platforms/unity/data-management/debug-files/index.mdx +++ b/docs/platforms/unity/data-management/debug-files/index.mdx @@ -27,7 +27,7 @@ the following formats: Source maps, while also being debug information files, are handled -differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps). +differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). diff --git a/docs/platforms/unity/data-management/debug-files/source-context/index.mdx b/docs/platforms/unity/data-management/debug-files/source-context/index.mdx index ae84589de0e62..5c4d923b0a178 100644 --- a/docs/platforms/unity/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/unity/data-management/debug-files/source-context/index.mdx @@ -18,7 +18,7 @@ because they have access to unobfuscated source code at runtime. By contrast, to get source context for compiled applications, the source code needs to be uploaded alongside the debug information files. The recommended way to do this is by using `sentry-cli`. -See [Creating Source Bundles](/product/cli/dif/#creating-source-bundles) for more information. +See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information. diff --git a/docs/platforms/unity/native-support/index.mdx b/docs/platforms/unity/native-support/index.mdx index 57badc5d74b2c..e42f6a7d67367 100644 --- a/docs/platforms/unity/native-support/index.mdx +++ b/docs/platforms/unity/native-support/index.mdx @@ -50,7 +50,7 @@ On Linux the Unity SDK includes the [Native SDK](/platforms/native/) with the br ## Debug Symbols -Sentry requires [debug information files](/platforms/unity/data-management/debug-files/) to symbolicate your crashes. The Unity SDK provides an automated upload functionality for those symbol files that rely on the [sentry-cli](/product/cli/). This is done transparently so you're not required to run `sentry-cli` manually. The symbol upload happens during Unity build in the editor. We've included the executables for Windows, macOS, and Linux as part of the Unity SDK package. +Sentry requires [debug information files](/platforms/unity/data-management/debug-files/) to symbolicate your crashes. The Unity SDK provides an automated upload functionality for those symbol files that rely on the [sentry-cli](/cli/). This is done transparently so you're not required to run `sentry-cli` manually. The symbol upload happens during Unity build in the editor. We've included the executables for Windows, macOS, and Linux as part of the Unity SDK package. The automated debug symbols upload is enabled by default but requires configuration. Go to **Tools > Sentry > Editor** to enter the [Auth Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/), Organization Slug, and the Project Name. Note that the Unity SDK creates a file at `Assets/Plugins/Sentry/SentryCliOptions.asset` to store the configuration, that should **not** be made publicly available. @@ -67,7 +67,7 @@ The automated symbol upload will take care of the `BCSymbolMap` files by process ### Manual Upload Using sentry-cli -If you don't want to rely on the automated symbol upload, you can run `sentry-cli` through the commandline. For that, you can use the provided executables from within the package or follow the [sentry-cli documentation](/product/cli/installation/) to make it available globally. To upload debug symbols, run it with: +If you don't want to rely on the automated symbol upload, you can run `sentry-cli` through the commandline. For that, you can use the provided executables from within the package or follow the [sentry-cli documentation](/cli/installation/) to make it available globally. To upload debug symbols, run it with: diff --git a/docs/platforms/unreal/configuration/debug-symbols/index.mdx b/docs/platforms/unreal/configuration/debug-symbols/index.mdx index 0d5f199b25f14..4a8ad02367a20 100644 --- a/docs/platforms/unreal/configuration/debug-symbols/index.mdx +++ b/docs/platforms/unreal/configuration/debug-symbols/index.mdx @@ -3,7 +3,7 @@ title: Debug Symbols Uploading description: "Learn how the Unreal Engine SDK handles debug symbols upload." --- -Sentry requires [debug information files](/platforms/unreal/data-management/debug-files/) to symbolicate crashes. The Unreal Engine SDK provides an automated upload functionality for those symbol files that rely on the [sentry-cli](/product/cli/). This is done automatically, so running the `sentry-cli` manually isn't required. The symbol upload happens during the execution of `PostBuildSteps`, as specified in the `Sentry.uplugin` file. The `sentry-cli` executables for Windows, macOS, and Linux are included as part of the Unreal Engine SDK package. They can also be downloaded manually via the settings menu if the plugin was installed from the UE Marketplace. +Sentry requires [debug information files](/platforms/unreal/data-management/debug-files/) to symbolicate crashes. The Unreal Engine SDK provides an automated upload functionality for those symbol files that rely on the [sentry-cli](/cli/). This is done automatically, so running the `sentry-cli` manually isn't required. The symbol upload happens during the execution of `PostBuildSteps`, as specified in the `Sentry.uplugin` file. The `sentry-cli` executables for Windows, macOS, and Linux are included as part of the Unreal Engine SDK package. They can also be downloaded manually via the settings menu if the plugin was installed from the UE Marketplace. @@ -25,7 +25,7 @@ Alternatively, debug symbol upload can be enabled by setting the `SENTRY_UPLOAD_ ### Manual Upload Using sentry-cli -To upload debug symbols to Sentry manually, run `sentry-cli` through the command line. You can either use the provided executables from within the package, or follow the [sentry-cli documentation](/product/cli/installation/) to make it available globally. To upload debug symbols run the following command: +To upload debug symbols to Sentry manually, run `sentry-cli` through the command line. You can either use the provided executables from within the package, or follow the [sentry-cli documentation](/cli/installation/) to make it available globally. To upload debug symbols run the following command: diff --git a/docs/platforms/unreal/configuration/releases.mdx b/docs/platforms/unreal/configuration/releases.mdx index 3d2f734fe736d..09f36f1ca875e 100644 --- a/docs/platforms/unreal/configuration/releases.mdx +++ b/docs/platforms/unreal/configuration/releases.mdx @@ -27,7 +27,7 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `package` is the unique identifier of the project/app (`CFBundleIdentifier` on iOS, `packageName` on Android) - `version` is the semver-like structure `...-` (`CFBundleShortVersionString` on iOS, `versionName` on Android) - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) -- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/product/cli/releases/#creating-releases) documentation. +- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. diff --git a/docs/platforms/unreal/data-management/debug-files/file-formats/index.mdx b/docs/platforms/unreal/data-management/debug-files/file-formats/index.mdx index 65a23118e1d85..21f4f8b7ed485 100644 --- a/docs/platforms/unreal/data-management/debug-files/file-formats/index.mdx +++ b/docs/platforms/unreal/data-management/debug-files/file-formats/index.mdx @@ -40,7 +40,7 @@ Sentry might not need all of the above information to process crash reports. Still, it is always a good idea to provide all available debug information. `sentry-cli` can be used to list properties of supported debug files and -validate their contents. See [_Debug Information Files in sentry-cli_](/product/cli/dif/) for more information. +validate their contents. See [_Debug Information Files in sentry-cli_](/cli/dif/) for more information. ## Mach-O and dSYM diff --git a/docs/platforms/unreal/data-management/debug-files/identifiers/index.mdx b/docs/platforms/unreal/data-management/debug-files/identifiers/index.mdx index 3a704b4c69d3b..aebce9d77c759 100644 --- a/docs/platforms/unreal/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/unreal/data-management/debug-files/identifiers/index.mdx @@ -39,7 +39,7 @@ their debug identifiers. You can copy this identifier and search for the exact files that match it in the _Debug Files_ settings screen. `sentry-cli` can help to print properties of debug information files like their -debug identifier. See [_Checking Debug Information Files_](/product/cli/dif/#checking-files) for more information. +debug identifier. See [_Checking Debug Information Files_](/cli/dif/#checking-files) for more information. ## GNU Build Identifiers diff --git a/docs/platforms/unreal/data-management/debug-files/index.mdx b/docs/platforms/unreal/data-management/debug-files/index.mdx index 40306c87f6993..b5a401b9febf2 100644 --- a/docs/platforms/unreal/data-management/debug-files/index.mdx +++ b/docs/platforms/unreal/data-management/debug-files/index.mdx @@ -27,7 +27,7 @@ the following formats: Source maps, while also being debug information files, are handled -differently in Sentry. For more information see [Source Maps in sentry-cli](/product/cli/releases/#sentry-cli-sourcemaps). +differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). diff --git a/docs/platforms/unreal/data-management/debug-files/source-context/index.mdx b/docs/platforms/unreal/data-management/debug-files/source-context/index.mdx index cbd8ac2e74e9b..5dd2f7647d6f9 100644 --- a/docs/platforms/unreal/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/unreal/data-management/debug-files/source-context/index.mdx @@ -22,7 +22,7 @@ because they have access to unobfuscated source code at runtime. By contrast, to get source context for compiled applications, the source code needs to be uploaded alongside the debug information files. The recommended way to do this is by using `sentry-cli`. -See [Creating Source Bundles](/product/cli/dif/#creating-source-bundles) for more information. +See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information. After they've been uploaded you can review and manage source bundles the same as any other debug information file. See [Managing Debug Information Files](../#managing-debug-information-files). diff --git a/docs/product/crons/legacy-endpoint-migration.mdx b/docs/product/crons/legacy-endpoint-migration.mdx index 425b12a8a7bd8..b5145c8b1b6c4 100644 --- a/docs/product/crons/legacy-endpoint-migration.mdx +++ b/docs/product/crons/legacy-endpoint-migration.mdx @@ -21,7 +21,7 @@ The SDKs do not utilize our legacy endpoints. -Versions of the `sentry-cli` **before v2.19.0** are using the legacy API endpoints. [Please upgrade](/product/cli/installation/#updating-and-uninstalling) to the latest version. +Versions of the `sentry-cli` **before v2.19.0** are using the legacy API endpoints. [Please upgrade](/cli/installation/#updating-and-uninstalling) to the latest version. If your CLI is configured with an auth token, it will use the legacy API endpoints. Please update your CLI configuration to utilize your project's DSN instead. Refer to the [configuration guide](https://docs.sentry.io/cli/crons/#configuration) for more information. diff --git a/docs/product/projects/index.mdx b/docs/product/projects/index.mdx index 15e7d45311c78..59970e9d60846 100644 --- a/docs/product/projects/index.mdx +++ b/docs/product/projects/index.mdx @@ -18,7 +18,7 @@ The **Projects** page lists all the projects assigned to teams you're a member o - A snapshot of both errors and transactions in the last 24 hours - The percentage of crash free sessions, if you have configured [release health](/product/releases/health/) (not available for watchOS; no Mach exception support on tvOS) -- Deploys, if you have configured your SDK to [provide a release identifier](/platform-redirect/?next=/configuration/releases/) and are tracking [deploys](/product/cli/releases/#creating-deploys) +- Deploys, if you have configured your SDK to [provide a release identifier](/platform-redirect/?next=/configuration/releases/) and are tracking [deploys](/cli/releases/#creating-deploys) **Tip:** For faster access, star your favorite projects to move them to the top of the page. diff --git a/docs/product/relay/getting-started.mdx b/docs/product/relay/getting-started.mdx index 9b2becebaa64e..e9dd3656d3b9c 100644 --- a/docs/product/relay/getting-started.mdx +++ b/docs/product/relay/getting-started.mdx @@ -224,7 +224,7 @@ and host of the DSN to:

Use the new DSN in your SDK configuration. To test this, you can send a message -with `sentry-cli` ([installation instructions](/product/cli/installation/)): +with `sentry-cli` ([installation instructions](/cli/installation/)): ```shell export SENTRY_DSN='http://12345abcdef10111213141516171819@127.0.0.1:3000/2345' diff --git a/docs/product/releases/associate-commits/index.mdx b/docs/product/releases/associate-commits/index.mdx index b564be19408fb..26367832fccd9 100644 --- a/docs/product/releases/associate-commits/index.mdx +++ b/docs/product/releases/associate-commits/index.mdx @@ -25,7 +25,7 @@ When you've associated commits, we can tie together the commits in the release, In this CLI example: -- Environment variables configure the CLI (see [Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects) for alternatives) +- Environment variables configure the CLI (see [Working with Projects](/cli/configuration/#sentry-cli-working-with-projects) for alternatives) - The `propose-version` sub-command determines a release ID automatically - A release tagged `VERSION` is created for the organization `my-org` for projects `project1` and `project2` - Because of the `--auto` flag, the repository name is determined automatically, and commits between the previous release’s head commit and the current head commit are associated with the release. diff --git a/docs/product/releases/setup/index.mdx b/docs/product/releases/setup/index.mdx index 5e394b50e6a84..081de2b5a01f9 100644 --- a/docs/product/releases/setup/index.mdx +++ b/docs/product/releases/setup/index.mdx @@ -65,7 +65,7 @@ sentry-cli releases --org ORGANIZATION_SLUG deploys VERSION new -e ENVIRONMENT -Make sure you have a [token](/product/cli/configuration/) properly configured. +Make sure you have a [token](/cli/configuration/) properly configured. @@ -75,4 +75,4 @@ You can also use our [API](/api/releases/create-a-new-deploy-for-an-organization When you notify Sentry that you've deployed a release to a new environment, we can automatically send an email to Sentry users who have committed to the release being deployed. -If [finalizing the release](/product/cli/releases/#finalizing-releases) isn't already included as part of your release automation process, make sure to do that. For more information, check out our [CLI documentation](/product/cli/releases/). +If [finalizing the release](/cli/releases/#finalizing-releases) isn't already included as part of your release automation process, make sure to do that. For more information, check out our [CLI documentation](/cli/releases/). diff --git a/docs/product/releases/setup/release-automation/circleci/index.mdx b/docs/product/releases/setup/release-automation/circleci/index.mdx index 6708b1e3d80a9..a447d9fb7d351 100644 --- a/docs/product/releases/setup/release-automation/circleci/index.mdx +++ b/docs/product/releases/setup/release-automation/circleci/index.mdx @@ -64,7 +64,7 @@ notify-sentry-deploy: sentry-cli deploys new -e $SENTRY_ENVIRONMENT ``` -For more details about the release management concepts in the snippet above, see the full documentation on [release management](/product/cli/releases/). +For more details about the release management concepts in the snippet above, see the full documentation on [release management](/cli/releases/). **Notes**: diff --git a/docs/product/releases/setup/release-automation/jenkins/index.mdx b/docs/product/releases/setup/release-automation/jenkins/index.mdx index df7816addde4b..2f6c30cddb7c2 100644 --- a/docs/product/releases/setup/release-automation/jenkins/index.mdx +++ b/docs/product/releases/setup/release-automation/jenkins/index.mdx @@ -39,7 +39,7 @@ Depending on what type of Jenkins project you're using to build and deploy, you - [Pipeline (Jenkinsfile)](/product/releases/setup/release-automation/jenkins/#pipeline) - [Freestyle project](/product/releases/setup/release-automation/jenkins/#freestyle-project) -For more details about the release management concepts below, see the full documentation on [release management](/product/cli/releases/). +For more details about the release management concepts below, see the full documentation on [release management](/cli/releases/). ### Pipeline diff --git a/docs/product/releases/setup/release-automation/travis-ci/index.mdx b/docs/product/releases/setup/release-automation/travis-ci/index.mdx index f4b681528141d..d607837f0e72b 100644 --- a/docs/product/releases/setup/release-automation/travis-ci/index.mdx +++ b/docs/product/releases/setup/release-automation/travis-ci/index.mdx @@ -57,7 +57,7 @@ jobs: sentry-cli deploys new -e $SENTRY_ENVIRONMENT ``` -For more details about the release management concepts in the snippet above, see the full documentation on [release management](/product/cli/releases/). +For more details about the release management concepts in the snippet above, see the full documentation on [release management](/cli/releases/). **Notes**: diff --git a/docs/product/sentry-basics/integrate-backend/configuration-options.mdx b/docs/product/sentry-basics/integrate-backend/configuration-options.mdx index afef57f4fce8a..832e0f805818b 100644 --- a/docs/product/sentry-basics/integrate-backend/configuration-options.mdx +++ b/docs/product/sentry-basics/integrate-backend/configuration-options.mdx @@ -8,7 +8,7 @@ Sentry has various configuration options to help enhance the SDK functionality. ## Releases -A _release_ is a version of your code that's deployed to an environment. Configuring the release helps you figure out if there's a regression in your code, ensure accountability, resolve issues within Sentry, and stay up-to-date with your deployments. Releases need to be configured within your SDK and then managed through the [sentry-cli](/product/cli/). +A _release_ is a version of your code that's deployed to an environment. Configuring the release helps you figure out if there's a regression in your code, ensure accountability, resolve issues within Sentry, and stay up-to-date with your deployments. Releases need to be configured within your SDK and then managed through the [sentry-cli](/cli/). Sentry currently supports integrations with GitHub, Bitbucket, Azure DevOps, GitLab, and others. For a complete list of our integrations, check out our [Integrations documentation](/organization/integrations/). diff --git a/docs/product/sentry-basics/integrate-backend/getting-started.mdx b/docs/product/sentry-basics/integrate-backend/getting-started.mdx index 22f9f47679635..7ae1b468bdcd9 100644 --- a/docs/product/sentry-basics/integrate-backend/getting-started.mdx +++ b/docs/product/sentry-basics/integrate-backend/getting-started.mdx @@ -21,7 +21,7 @@ If you're using your own source code, you can skip this tutorial and either: - A source code editor (like [VS-Code](https://code.visualstudio.com)) - [Python](https://www.python.org/) - - [Sentry-CLI](/product/cli/) + - [Sentry-CLI](/cli/) 2. To start monitoring errors in your application you'll need to create a new project in your Sentry account. @@ -139,7 +139,7 @@ In addition to installing Python requirements and running the server, we also us ![Makefile Config](./img/makefile_config.png) - > The `sentry-cli` can be configured by providing these values either through environment variables or through a dedicated configuration file. Learn more in [Sentry CLI: Configuration and Authentication](/product/cli/configuration/). + > The `sentry-cli` can be configured by providing these values either through environment variables or through a dedicated configuration file. Learn more in [Sentry CLI: Configuration and Authentication](/cli/configuration/). 9. Run the following command to install the required Python libraries, set up the Sentry Release, and run the Django server: diff --git a/includes/sentry-cli-sourcemaps.mdx b/includes/sentry-cli-sourcemaps.mdx index 6aedeab445f3a..8f2f090f7b576 100644 --- a/includes/sentry-cli-sourcemaps.mdx +++ b/includes/sentry-cli-sourcemaps.mdx @@ -2,9 +2,9 @@ -You can find installation instructions for Sentry CLI here: https://docs.sentry.io/product/cli/installation/ +You can find installation instructions for Sentry CLI here: https://docs.sentry.io/cli/installation/ -For more info on `sentry-cli` configuration visit the [Sentry CLI configuration docs](/product/cli/configuration/). +For more info on `sentry-cli` configuration visit the [Sentry CLI configuration docs](/cli/configuration/). @@ -100,7 +100,7 @@ sentry-cli sourcemaps upload --release= /path/to/directory Running `upload` with `--release` **doesn't automatically create a release in Sentry**. -Either wait until the first event with the new release set in `Sentry.init` is sent to Sentry, or create a release with the same name in a separate step [with the CLI](/product/cli/releases). +Either wait until the first event with the new release set in `Sentry.init` is sent to Sentry, or create a release with the same name in a separate step [with the CLI](/cli/releases). diff --git a/platform-includes/debug-symbols-apple/_default.mdx b/platform-includes/debug-symbols-apple/_default.mdx index 64056ccc29cc7..3501a13841b56 100644 --- a/platform-includes/debug-symbols-apple/_default.mdx +++ b/platform-includes/debug-symbols-apple/_default.mdx @@ -78,7 +78,7 @@ Your project's dSYM can be uploaded during Xcode's build phase as a _Run Script_ Follow these steps to upload the debug symbols: -1. Download and install [sentry-cli](/product/cli/installation/). +1. Download and install [sentry-cli](/cli/installation/). 2. Copy the script below into a new _Run Script_ and set your _AUTH_TOKEN_, _ORG_SLUG_, and _PROJECT_SLUG_. Sentry can display snippets of your code next to the event stack traces. This feature is called source context. When setting the `--include-sources` option, sentry-cli will scan your debug files to find references to the source code files, resolve them in the local file system, bundle them up, and upload them to Sentry. diff --git a/platform-includes/source-context/java.mdx b/platform-includes/source-context/java.mdx index 45909039f7193..0e55657a9ec83 100644 --- a/platform-includes/source-context/java.mdx +++ b/platform-includes/source-context/java.mdx @@ -3,7 +3,7 @@ You'll need to enable the Source Context feature to see your source code as part - By adding one of a build tool plugin to your project - Or, by manually uploading your source bundle using the Sentry CLI -This document covers both methods. You can find more information about uploading via the CLI in our [Debug Information Files](/product/cli/dif/#jvm-source-bundles) docs. +This document covers both methods. You can find more information about uploading via the CLI in our [Debug Information Files](/cli/dif/#jvm-source-bundles) docs. diff --git a/platform-includes/sourcemaps/legacy-troubleshooting/javascript.mdx b/platform-includes/sourcemaps/legacy-troubleshooting/javascript.mdx index 5532da0544032..6ebf402308d80 100644 --- a/platform-includes/sourcemaps/legacy-troubleshooting/javascript.mdx +++ b/platform-includes/sourcemaps/legacy-troubleshooting/javascript.mdx @@ -5,7 +5,7 @@ Setting up source maps can be tricky, but it's worth it to get it right. To trou ## Use the Sentry CLI -To use the automated verification process, install and configure the Sentry [Command Line Interface](/product/cli/). Then, use the `sourcemaps explain` command, calling it with the relevant event ID, found in the top-left corner of the **Issue Details** page in [sentry.io](https://sentry.io). +To use the automated verification process, install and configure the Sentry [Command Line Interface](/cli/). Then, use the `sourcemaps explain` command, calling it with the relevant event ID, found in the top-left corner of the **Issue Details** page in [sentry.io](https://sentry.io). For example, "Event ID: c2ad049f": diff --git a/platform-includes/sourcemaps/legacy-uploading-methods/javascript.mdx b/platform-includes/sourcemaps/legacy-uploading-methods/javascript.mdx index 02e4c0f7d8b9d..c8bf6a191d9aa 100644 --- a/platform-includes/sourcemaps/legacy-uploading-methods/javascript.mdx +++ b/platform-includes/sourcemaps/legacy-uploading-methods/javascript.mdx @@ -270,7 +270,7 @@ To troubleshoot your source maps set up, you can either: ### Use the Sentry CLI -To use the automated verification process, install and configure the Sentry [Command Line Interface](/product/cli/). Then, use the `sourcemaps explain` command, calling it with the relevant event ID, found in the top-left corner of the **Issue Details** page in [sentry.io](https://sentry.io). +To use the automated verification process, install and configure the Sentry [Command Line Interface](/cli/). Then, use the `sourcemaps explain` command, calling it with the relevant event ID, found in the top-left corner of the **Issue Details** page in [sentry.io](https://sentry.io). diff --git a/platform-includes/sourcemaps/overview/javascript.remix.mdx b/platform-includes/sourcemaps/overview/javascript.remix.mdx index 8defd2e46572a..fb91692dcdfd6 100644 --- a/platform-includes/sourcemaps/overview/javascript.remix.mdx +++ b/platform-includes/sourcemaps/overview/javascript.remix.mdx @@ -69,7 +69,7 @@ To see the full list of options, refer to the [Vite plugin documentation](https: If you're not using Vite to build your project, you can use the `sentry-upload-sourcemaps` script to upload source maps to Sentry. The Sentry Remix SDK provides a script to automatically create a release and upload source maps after you've built your project. -Under the hood, it uses the [Sentry CLI](/product/cli/). +Under the hood, it uses the [Sentry CLI](/cli/). This script requires setting an auth token, which can either be done through a `.sentryclirc` file in the root of your project or through environment variables: diff --git a/platform-includes/sourcemaps/troubleshooting/javascript.mdx b/platform-includes/sourcemaps/troubleshooting/javascript.mdx index d3ea061c16359..c26ea7ba1c149 100644 --- a/platform-includes/sourcemaps/troubleshooting/javascript.mdx +++ b/platform-includes/sourcemaps/troubleshooting/javascript.mdx @@ -37,7 +37,7 @@ Setting up source maps can be tricky, but it's worth it to get it right. To trou ## Use the CLI -To use the automated verification process, install and configure the Sentry [Command Line Interface](/product/cli/). Then, use the `sourcemaps explain` command, calling it with the relevant event ID, found in the top-left corner of the **Issue Details** page in [sentry.io](https://sentry.io). +To use the automated verification process, install and configure the Sentry [Command Line Interface](/cli/). Then, use the `sourcemaps explain` command, calling it with the relevant event ID, found in the top-left corner of the **Issue Details** page in [sentry.io](https://sentry.io). For example, "Event ID: c2ad049f": diff --git a/platform-includes/sourcemaps/upload/primer/javascript.remix.mdx b/platform-includes/sourcemaps/upload/primer/javascript.remix.mdx index 7d5472764f3f3..a037ba411495c 100644 --- a/platform-includes/sourcemaps/upload/primer/javascript.remix.mdx +++ b/platform-includes/sourcemaps/upload/primer/javascript.remix.mdx @@ -2,7 +2,7 @@ On release, call `yarn sentry-upload-sourcemaps` to upload source maps and creat -`sentry-upload-sourcemaps` requires either [`env` variables](/product/cli/configuration/#configuration-values) or a valid `.sentryclirc` file to pick up your project ID, organization ID, and token. You can create the `.sentryclirc` file with necessary configuration, as documented on this [page](/product/cli/configuration/). +`sentry-upload-sourcemaps` requires either [`env` variables](/cli/configuration/#configuration-values) or a valid `.sentryclirc` file to pick up your project ID, organization ID, and token. You can create the `.sentryclirc` file with necessary configuration, as documented on this [page](/cli/configuration/).