Installation

Learn about the different methods available to install `sentry-cli`.

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 macOS 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.46.0" 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.46.0)Integrity Checksum
sentry-cli-Darwin-arm64sha384-6ba604d1241e989025500bd031f6a6fea5b2291deeff6ae1a1dcd2abc0c622c3
sentry-cli-Darwin-universalsha384-8b90c89cbff071230457b80344c6ac7a1d04a76debefb6d702b4509605beba23
sentry-cli-Darwin-x86_64sha384-afbd4c7d3b60bdf6d02f252fed316af75a61238f02946fe94676f74aeed2f4ab
sentry-cli-Linux-aarch64sha384-00b292f4edc9c13b079123b574abe73c012b7357426d34bbbf0bd0a5ab59a491
sentry-cli-Linux-armv7sha384-a0c2c9eec2d9c25e99c6e9acde8b0cae295d9c9a291a6964340f5f19dd72fa21
sentry-cli-Linux-i686sha384-a87f426738a3f32dcbb84973d1b5fb6d78bdc2fa4b172236f7b3a72c30bc8c14
sentry-cli-Linux-x86_64sha384-a55b96a0d5391c5206c2bc028e52dd9797dc3646556291cca09d00a19707f85e
sentry-cli-Windows-aarch64.exesha384-633470992be9f03ee79f0c0fb724a81057922324031010a93473b6d85fe70c4f
sentry-cli-Windows-i686.exesha384-c7f4cfdfe9a84a84c10fa00b6bd9bd92ea3d807579242f551701853c538150d0
sentry-cli-Windows-x86_64.exesha384-aa86012bd7cc27ceac04357399a00373f1f0909f93b7735778dca7b9e1f4099c
sentry_cli-2.46.0-py3-none-macosx_10_15_x86_64.whlsha384-6c80f49bdbf2b3fd104ba696ded68a8d9a518f28ec1e9e2b7b05ade5eb3307c6
sentry_cli-2.46.0-py3-none-macosx_11_0_arm64.whlsha384-1dd3903062681676aa50de616f213f4dbb359605295f9163c8831d8068f13b42
sentry_cli-2.46.0-py3-none-macosx_11_0_universal2.whlsha384-8369574681d44750ce8c5a67a0b0740bf7f8c351e68c3675a0ffb8d0a47c9a99
sentry_cli-2.46.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whlsha384-d78afbc87ee07198ac89133f4fb9a005e2ba28463f16015c4eed47763629b73c
sentry_cli-2.46.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whlsha384-f77c270b78120fb5cab26e6ce7b4e9594fe359d41c3615c45e1e8f0d1e1176d6
sentry_cli-2.46.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whlsha384-479c9a37fcf049be2471a0c8059666122f32b41a3e8bc51d7756f9c5525bd7fc
sentry_cli-2.46.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whlsha384-f57fb25fbfe38d82d8e27c77a5049113adb40cff120846c11b133f0fc227f5f3
sentry_cli-2.46.0-py3-none-win32.whlsha384-6289f53f8d80b40c3f7e815219e8a70aed7808ece15b02486c118ef2bdc49be6
sentry_cli-2.46.0-py3-none-win_amd64.whlsha384-2472a65d0da8b6ce09f9c8594303eea7ee8c29203d4940f025e45121444e439b
sentry_cli-2.46.0-py3-none-win_arm64.whlsha384-480bd8b857a7df821b12a31d8d6853c2c41786d97d1ef411b004b7d863179fc8
sentry_cli-2.46.0.tar.gzsha384-6085ce201e128483dac639cbb76474b949c89cbda32b65dc5284c1928e6719ef

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.

Was this helpful?
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").