diff --git a/docs/cli/code-mappings.mdx b/docs/cli/code-mappings.mdx index 039f12e0de20b..be4f0e7000cc8 100644 --- a/docs/cli/code-mappings.mdx +++ b/docs/cli/code-mappings.mdx @@ -3,6 +3,9 @@ title: "Code Mappings" sidebar_order: 5 description: "Upload code mappings to Sentry via the CLI. Code mappings link stack trace paths to source code paths in your repository, enabling source context, suspect commits, and code owners." --- + + + _Available in version 3.3.4 of Sentry CLI_ Code mappings link stack trace paths to source code paths in your repository. They enable features like [source context](/platforms/java/source-context/), [suspect commits](/product/issues/suspect-commits/), [stack trace linking](/integrations/source-code-mgmt/github/#stack-trace-linking), and [code owners](/product/issues/ownership-rules/). diff --git a/docs/cli/configuration.mdx b/docs/cli/configuration.mdx index d3d943cdac7ba..81599834e82ce 100644 --- a/docs/cli/configuration.mdx +++ b/docs/cli/configuration.mdx @@ -4,6 +4,8 @@ sidebar_order: 1 description: "Learn about the functionality of Sentry’s command line interface, including installation, configuration, and authentication." --- + + For most functionality you need to authenticate with Sentry. Setting this up can be done either automatically, using `sentry-cli`, or manually via [Organization Tokens](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/). ## To use the automatic option: diff --git a/docs/cli/crons.mdx b/docs/cli/crons.mdx index 69261a9b63326..a09e1036fc4cf 100644 --- a/docs/cli/crons.mdx +++ b/docs/cli/crons.mdx @@ -4,6 +4,8 @@ sidebar_order: 200 description: "Follow this guide to set up and manage monitors using the Sentry CLI." --- + + Starting with v2.16.1 of the Sentry CLI, the ability to monitor check-ins using an auth token for authorization has been deprecated. Read on to learn how to update your CLI and use your project's DSN instead. diff --git a/docs/cli/dif.mdx b/docs/cli/dif.mdx index deaa220063e8d..4910b43def07b 100644 --- a/docs/cli/dif.mdx +++ b/docs/cli/dif.mdx @@ -4,6 +4,8 @@ sidebar_order: 3 description: "Debug information files allow Sentry to extract stack traces and provide more information about crash reports for most compiled platforms. Sentry's CLI can be used to validate and upload debug information files. " --- + + Debug information files allow Sentry to extract stack traces and provide more information about crash reports for most compiled platforms. `sentry-cli` can be used to validate and upload debug information files. For more general diff --git a/docs/cli/index.mdx b/docs/cli/index.mdx index 9b56d5d463c9e..5b26dc7187c99 100644 --- a/docs/cli/index.mdx +++ b/docs/cli/index.mdx @@ -12,11 +12,7 @@ keywords: description: "Learn how to use the `sentry-cli` command line executable." --- - - -These docs cover `sentry-cli`, used in CI/CD pipelines and build processes. If you're looking for the interactive developer CLI with issue management, AI-powered analysis, and API access for humans and agents, check out the new [Sentry CLI](https://cli.sentry.dev/). - - + For certain actions, you can use the `sentry-cli` command line executable. It can connect to the Sentry API and manage some data for your projects. It’s primarily used for managing debug information files for iOS, Android, release and source maps management, as well as code mappings for other platforms. diff --git a/docs/cli/installation.mdx b/docs/cli/installation.mdx index acc96f17aabb1..714939f67533e 100644 --- a/docs/cli/installation.mdx +++ b/docs/cli/installation.mdx @@ -4,6 +4,8 @@ sidebar_order: 0 description: "Learn about the different methods available to install `sentry-cli`." --- + + Depending on your platform, there are different methods available to install `sentry-cli`. ## Manual Download diff --git a/docs/cli/logs.mdx b/docs/cli/logs.mdx index d96762b5d2030..2f4459435ab46 100644 --- a/docs/cli/logs.mdx +++ b/docs/cli/logs.mdx @@ -4,6 +4,8 @@ sidebar_order: 5 description: "Learn how to view and stream logs using the Sentry CLI." --- + + The `sentry-cli` tool can be used to view and stream logs from your Sentry projects. This allows you to monitor your application logs directly from the command line. ## Requirements diff --git a/docs/cli/releases.mdx b/docs/cli/releases.mdx index 6c9a4ce2e22c0..dfc5ff63b9dc9 100644 --- a/docs/cli/releases.mdx +++ b/docs/cli/releases.mdx @@ -4,6 +4,8 @@ sidebar_order: 2 description: "Sentry's command line interface can be used for release management. The CLI allows you to create, edit and delete releases as well as upload release artifacts." --- + + The `sentry-cli` tool can be used for release management on Sentry. It allows you to create, edit and delete releases as well as upload release artifacts for them. Note that releases are global per organization. If you want the releases in different projects to be treated as separate entities, make the version name unique across the organization. For example, if you have projectA and projectB that share version numbers, you can name the releases `projectA-1.0` and `projectB-1.0` respectively. diff --git a/docs/cli/send-event.mdx b/docs/cli/send-event.mdx index d8bc080469902..3573586562387 100644 --- a/docs/cli/send-event.mdx +++ b/docs/cli/send-event.mdx @@ -4,6 +4,8 @@ sidebar_order: 4 description: "Learn how Sentry's command line interface can be used for sending events." --- + + The `sentry-cli` tool can also be used for sending events. If you want to use it, you need to export the `SENTRY_DSN` environment variable and point it to the DSN of a project of yours: diff --git a/docs/cli/snapshots.mdx b/docs/cli/snapshots.mdx index b60a3386169cb..861e450d2a3a8 100644 --- a/docs/cli/snapshots.mdx +++ b/docs/cli/snapshots.mdx @@ -5,6 +5,8 @@ description: "Upload snapshot images to Sentry with sentry-cli for visual diffin beta: true --- + + The `sentry-cli snapshots upload` command uploads a directory of images to [Snapshots](/product/snapshots/) for visual diffing against a base build. diff --git a/includes/cli-looking-for-sentry-cli.mdx b/includes/cli-looking-for-sentry-cli.mdx new file mode 100644 index 0000000000000..ffce52e6a29ba --- /dev/null +++ b/includes/cli-looking-for-sentry-cli.mdx @@ -0,0 +1,5 @@ + + +These docs cover `sentry-cli`, used in CI/CD pipelines and build processes. If you're looking for the interactive developer CLI with issue management, AI-powered analysis, and API access for humans and agents, check out the new [Sentry CLI](https://cli.sentry.dev/). + +