Installation

Depending on your platform, there are different methods available to install sentry-cli.

Manual Download

You can find the list of releases on the GitHub release page. We provide executables for Linux, OS X and Windows. It’s a single file download and upon receiving the file you can rename it to just sentry-cli or sentry-cli.exe to use it.

Automatic Installation

If you are on OS X or Linux, you can use the automated downloader which will fetch the latest release version for you and install it:

Copied
curl -sL https://sentry.io/get-cli/ | sh

We do however, encourage you to pin the specific version of the CLI, so your builds are always reproducible. To do that, you can use the exact same method, with an additional version specifier:

Copied
curl -sL https://sentry.io/get-cli/ | SENTRY_CLI_VERSION="2.21.1" sh

This will automatically download the correct version of sentry-cli for your operating system and install it. If necessary, it will prompt for your admin password for sudo. For a different installation location or for systems without sudo (like Windows), you can export INSTALL_DIR=/custom/installation/path before running this command.

To verify it’s installed correctly you can bring up the help:

Copied
sentry-cli --help

Installation via NPM

There is also the option to install sentry-cli via npm for specialized use cases. This, for instance, is useful for build servers. The package is called @sentry/cli and in the post installation it will download the appropriate release binary:

Copied
npm install @sentry/cli

You can then find it in the .bin folder:

Copied
./node_modules/.bin/sentry-cli --help

In case you want to install this with npm system wide with sudo you will need to pass -–unsafe-perm to it:

Copied
sudo npm install -g @sentry/cli --unsafe-perm

Downloading From a Custom Source

By default, this package will download sentry-cli from the CDN managed by Fastly. To use a custom CDN, set the npm config property sentrycli_cdnurl. The downloader will append "/<version>/sentry-cli-<dist>".

Copied
npm install @sentry/cli --sentrycli_cdnurl=https://mymirror.local/path

Or add property into your .npmrc file (https://docs.npmjs.com/files/npmrc)

Copied
sentrycli_cdnurl=https://mymirror.local/path

Another option is to use the environment variable SENTRYCLI_CDNURL.

Copied
SENTRYCLI_CDNURL=https://mymirror.local/path npm install @sentry/cli

Available Installation Options

Options listed below control how sentry-cli install script behaves, when installed through npm.

SENTRYCLI_CDNURL:
If set, the script will use given URL for fetching the binary. Defaults to https://downloads.sentry-cdn.com/sentry-cli.

SENTRYCLI_USE_LOCAL:
If set to 1, sentry-cli binary will be discovered from your $PATH and copied locally instead of being downloaded from external servers. It will still verify the version number, which has to match.

SENTRYCLI_SKIP_DOWNLOAD:
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 page.

SENTRYCLI_NO_PROGRESS_BAR:
If set to 1, the script will not display download progress bars. This is a default behavior for CI environments.

SENTRYCLI_LOG_STREAM:
If set, the script will change where it writes its output. Possible values are stdout and stderr. Defaults to stdout.

Installation via Homebrew

If you are on OS X, you can install sentry-cli via homebrew:

Copied
brew install getsentry/tools/sentry-cli

Installation via Scoop

If you are on Windows, you can install sentry-cli via Scoop:

Copied
> scoop install sentry-cli

Docker Image

For unsupported distributions and CI systems, we offer a Docker image that comes with sentry-cli preinstalled. It is recommended to use the latest tag, but you can also pin to a specific version. By default, the command runs inside the /work directory. Mount relevant

projectRepresents your service in Sentry and allows you to scope events to a distinct application.
folders and build outputs there to allow sentry-cli to scan for resources:

Copied
docker pull getsentry/sentry-cli
docker run --rm -v $(pwd):/work getsentry/sentry-cli --help

Updating and Uninstalling

You can use sentry-cli update and sentry-cli uninstall to update or uninstall the sentry-cli binary. These commands may be unavailable in certain situations, generally when sentry-cli has been installed by a tool like homebrew or yarn, either directly or as a dependency of another package. In those cases, the same tool will need to be used for updating and removal. If you find that sentry-cli update and sentry-cli uninstall aren't working and you don't know how the package was installed, running which sentry-cli will often provide a clue as to which tool to use.

Build Checksums

When downloading an executable from a remote server, it's often a good practice to verify, that what has been downloaded, is in fact what we expect it to be. To make sure that this is the case, we can use checksum validation. A checksum is the value calculated from the contents of a file, in a form of hash, in our case SHA256, and it acts as the data integrity check, as it's always producing the same output, for a given input.

Below is the table of SHA256 checksums for all available build targets that our CLI supports. To calculate the hash of a downloaded file, you can use sha256sum utility, which is preinstalled in OSX and most Linux distributions.

Filename (v2.21.1)Integrity Checksum
sentry-cli-Darwin-arm64sha384-14873f24b9b35b5fa164899e35461d296c54910c149834495fc09890aad3e476
sentry-cli-Darwin-universalsha384-b3fa785eb951a1baa19c5eadff88f62294249e34f57bc3ca619e6ed3fcc191d8
sentry-cli-Darwin-x86_64sha384-52fb15bfb2d90fc279ae8aee2fb4adf91a93e8b56fe3969d907045c08927e03e
sentry-cli-Linux-aarch64sha384-14a0085f8008313a27b89332682d81a61621d7d368c76c93c46c5f01b34ee441
sentry-cli-Linux-armv7sha384-6363f60fbad5204abc7f70f7ca82c857c9b3c0ecde073fb5f89b23f3c808fcad
sentry-cli-Linux-i686sha384-f30d67893c9eb7b193658fb7cf2f066aa9c44af37d0c9ad4f2fd885b2abe5a1b
sentry-cli-Linux-x86_64sha384-dbdd719481867f55072c7769d04ad3f70dda648ef406b87f613722d09a0ec625
sentry-cli-Windows-i686.exesha384-d2a3ea8c7ecdaddd8cf5fb8da09667b647a926870a6c172f42a7686cd71abdaf
sentry-cli-Windows-x86_64.exesha384-f0fcd76905e8f0f06a7d8c35d667a485fefd88495cdc1ac0603c99e6c39e9b98
sentry_cli-2.21.1-py3-none-macosx_10_15_x86_64.whlsha384-775f57e90c2c0b99f09c5fa9381168bac5d34ccbbc45f6e4ad02d1123d83ff9d
sentry_cli-2.21.1-py3-none-macosx_11_0_arm64.whlsha384-4294f3e53f7748935f346ec1a6f6e120d3e37e90f417c02ee12b0167228164f3
sentry_cli-2.21.1-py3-none-macosx_11_0_universal2.whlsha384-0469a6136adc746a9acdebeb2238d4a26898d78cf1a22415e97ebf1514b42481
sentry_cli-2.21.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whlsha384-485b7fc711c0d459b4dbe6c3208cfe58e3efd11f0f90a13020eeb48163a33c59
sentry_cli-2.21.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whlsha384-969dec9fd6ecbc541bc0cd220a4a2980b767cd2c27a653c2b691ab739d28f604
sentry_cli-2.21.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whlsha384-7661d1c20187faef4312e6be1e5d305330e6f3de8a2645167cf47caf592c97a4
sentry_cli-2.21.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whlsha384-9e67ac4912870bfa8001cd397bfa58bc87bdbc5e8e22c1064ae9e302ca30c289
sentry_cli-2.21.1-py3-none-win32.whlsha384-80617faa53b5bda535d0cffeabccc354d3267c714c10ed69a993ab42b3a95664
sentry_cli-2.21.1-py3-none-win_amd64.whlsha384-03cfd8f5d68560188c15f18a033439c1545ee96e4b1886682e5b40ef840e970b
sentry_cli-2.21.1.tar.gzsha384-3f3a859b6e2f49339a3827f8ecbfb99ce674a53e72e1871efdaa4bcb172a56b6

If you would like to verify checksums for historic versions of the sentry-cli, please refer to our release registry directly, which can be found at https://release-registry.services.sentry.io/apps/sentry-cli/{version}. For example, https://release-registry.services.sentry.io/apps/sentry-cli/1.74.4.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").
Suggest an edit to this page   |  Contribute to Docs   |  

Report a Problem

🎉 Thank you for your feedback! 🙌
Report a problem