Installation

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

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.

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

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

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

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.

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

Copied
brew install getsentry/tools/sentry-cli

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

Copied
> scoop install sentry-cli

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

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.

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.28.6)Integrity Checksum
sentry-cli-Darwin-arm64sha384-edd243745f2f7bb49625c9168b1b5f330d9599724fa6125e38c6ecde243c5ae7
sentry-cli-Darwin-universalsha384-642160062d1873e41828c26cddd30065358f33613bcd1152df31d1e95839a67c
sentry-cli-Darwin-x86_64sha384-2f25d8872d85dad154b68342d7c0b3135477342e4253af799d31195270caf044
sentry-cli-Linux-aarch64sha384-de763704846669f2b8345327333850aecea372310f573aa5838d5868b5ffb681
sentry-cli-Linux-armv7sha384-c37a6c4fbb5c7f0c3a02c608d71753396a041de1188add6241588022a1c3650d
sentry-cli-Linux-i686sha384-4ba889f03d984628cd41d3957ef779b43a262b3eefd30d57469c517c7ffb7eb2
sentry-cli-Linux-x86_64sha384-790c1c4a0e59112d25b8efdf00211881851f4f33443c4e885df336d16b88b457
sentry-cli-Windows-i686.exesha384-7a0ee9dfe78841e0ae9e9965a8dc74d544539ed0689b90141fe0323b423c9096
sentry-cli-Windows-x86_64.exesha384-162da8bc6e96f0081976f33a66ee8a034f3f8eaf5fb377309b20b36831b42234
sentry_cli-2.28.6-py3-none-macosx_10_15_x86_64.whlsha384-014362ffc3187f9e4efad266bc578e3385f83e78732da6f97ab6ae1c36369c53
sentry_cli-2.28.6-py3-none-macosx_11_0_arm64.whlsha384-3b31cb77cb9a20384369523db397ca4331f1c4f2e40e7479c47604a8b75babd4
sentry_cli-2.28.6-py3-none-macosx_11_0_universal2.whlsha384-1913d3342fae8b221fd02382871b1b01e2d8eab43be13cf549eca06f84a971f7
sentry_cli-2.28.6-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whlsha384-0007b0fd151906082cd43bc72347a907a0a28426b3cb8963444f6a211ff563ea
sentry_cli-2.28.6-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whlsha384-5667b3332aa8884e0830ffc96436d6bdcc633a2137bec5d4fdc3c2a4c1525810
sentry_cli-2.28.6-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whlsha384-2631255b756d16587dfea22d0d32dd71dee3c95b91ad004f5a7802390ec6cade
sentry_cli-2.28.6-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whlsha384-c4a80f65498ecd2cfaa91f930a4848628bd5a343abd6e15546b1de808aa9a739
sentry_cli-2.28.6-py3-none-win32.whlsha384-a61d26981b6cbccaa7da003163593700fa7a5bb4ff311d20fd0fc70d49a857b3
sentry_cli-2.28.6-py3-none-win_amd64.whlsha384-fcd961567683f93ab389a36aaec4e6e5570c4ace687fd8bbd31ad310018c60c3
sentry_cli-2.28.6.tar.gzsha384-26b6dad518137e6a67f4609467429c68dd8461a1572c2ed1f5c2c761c5472a0f

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!) or suggesting an update ("yeah, this would be better").