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/ | bash

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.5.2" bash

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 project 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.5.2)Integrity Checksum
sentry-cli-Darwin-arm64sha384-e1296b3b765dc0a8d70ae051e428a91186e6933b3d0a14946652f9430fc329a8
sentry-cli-Darwin-universalsha384-abead2d834cd5a99b610e1de71cb4e3f15aef9ffdbf0f968bd9f73bf4aa12a2b
sentry-cli-Darwin-x86_64sha384-774f1076d7d014526b818dfa8c5f38297bea2fae4f33e93a1ae13e5bc1c705b6
sentry-cli-Linux-aarch64sha384-a8f1ed844b37531d4a8b24aee83f2e53024ed0b96ba46d052c11c24feca3bb81
sentry-cli-Linux-armv7sha384-c09a2f4e04acb722e371dd12ed03d171bad404eda7fca9b18910e7032a7b23a4
sentry-cli-Linux-i686sha384-b5fd5394ca4fa77e344f5aa01e39225202ab73fb6c94f390f750f1d8c8b242a9
sentry-cli-Linux-x86_64sha384-185796be2b7a94be23be9494b56adb213573460e80b27dd4a6369379a089bfd0
sentry-cli-Windows-i686.exesha384-53a371a0eb5f0aedded9796aba9b0a6998625322850b02755e1e69aec0ee2ac0
sentry-cli-Windows-x86_64.exesha384-7226af2f18452a97f47054c28a5bb97470e2818b0fe741082ef704b1fe259540

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").