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 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.41.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

This installation is not recommended however.

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.41.0)Integrity Checksum
sentry-cli-Darwin-arm64sha384-2586aba2a82789e4f2124ba9625d26237fc40b1d1acb72b1b216965fb23aa975
sentry-cli-Darwin-universalsha384-f27ae31637e41e68bd79bcb17d785e77256e2449bb6a914add7af3a55d83ea9a
sentry-cli-Darwin-x86_64sha384-974b4bfd50eafff7902f700dc47585ffac05bbbe5c246a0756561c72a6ec88b7
sentry-cli-Linux-aarch64sha384-40e5a0f23e01cc1102fdd550badd860e669bc3e9e7d6bfdcaac47110489c1b74
sentry-cli-Linux-armv7sha384-8a8654630a8159ee177bedc40dd46b540ad53f0bbd9a226bf948cb5c9f2c7ae8
sentry-cli-Linux-i686sha384-29e58e4935f238cf6cd66c32b8f0542d4ba40324d9dc95705df19e832e08784b
sentry-cli-Linux-x86_64sha384-dc9475a1cce1f5f5d8cd14803c2b1b1c73f4d4c9c804617b2950f7699740226a
sentry-cli-Windows-i686.exesha384-fc8aa4f818318c58fd5d3087326b0bb98649d208d05e244eaea04171545a3a47
sentry-cli-Windows-x86_64.exesha384-a8a8a98ca479c3e291bab445d48bf873f952c15f046405aee279965ee81a2689
sentry_cli-2.41.0-py3-none-macosx_10_15_x86_64.whlsha384-f048aa3d275dd75ba77312e63a6bf6d55eea9e7a4f61c051c75f279c140e7587
sentry_cli-2.41.0-py3-none-macosx_11_0_arm64.whlsha384-487336e7863c7b8dbc57271583ec15711914683be9a05440165dd2a49ab62d5a
sentry_cli-2.41.0-py3-none-macosx_11_0_universal2.whlsha384-f6e6a9933441824882e318c28b8471935c1b08d6d0955d1a3c4525145fa42e91
sentry_cli-2.41.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whlsha384-c05099af75ce4209e12372458bd4a346fbdca58874933dea9e6dc8909a61287d
sentry_cli-2.41.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whlsha384-b196de49972b74a8ee9124465f28ad2d689a58a686e5099330b57503000f1b6d
sentry_cli-2.41.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whlsha384-b70dbc1406a783843751761425ec4b99e69490a8ea95094ffb84e9043f2f6980
sentry_cli-2.41.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whlsha384-5a1f28db569603d58af0fbbea543304fb3cd7fcace127001f2815e2a8d0f4691
sentry_cli-2.41.0-py3-none-win32.whlsha384-e69e2ab458e9cb424e4306b1a441226e8e15c14d7469e15edd8b3b7d1c16ff36
sentry_cli-2.41.0-py3-none-win_amd64.whlsha384-cbcb4894b23cf1b240ae7c323254fc55d9047b5f5a1ebc8ea344a598836bc15f
sentry_cli-2.41.0.tar.gzsha384-4634984ad72ca2cff59ccdcac35298a790afc83cedb35fad53259f5891b16626

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