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

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.41.1)Integrity Checksum
sentry-cli-Darwin-arm64sha384-1ea7af1fb121d1274f512c8419ede11c9ebd2f249089a0b006041a3d5466febb
sentry-cli-Darwin-universalsha384-4b6703bb6160accb7d3552128945357910ff273fde5d5a8aa4d1668958bb9472
sentry-cli-Darwin-x86_64sha384-b02484e776275d7ab94702f26976d8eb36d3450548edbc1b12acca1f2ce4123f
sentry-cli-Linux-aarch64sha384-a2361706bd8fd624edd73945f70e7ff761163258476292872dadea1bfe2f241e
sentry-cli-Linux-armv7sha384-1425497df41f65a6b1777ad2806324bcf5980044c8b48a7cffc0e1ba5e471857
sentry-cli-Linux-i686sha384-11988b764a08ff3711582854cae7e0b31cfbb3164bb1c9798d4fb1e89c0a9a02
sentry-cli-Linux-x86_64sha384-a007369907840f26b68d0ce83037abf2b14fc68162fdef1d071885a1ace5e3cf
sentry-cli-Windows-i686.exesha384-8a25bfb2c550a067966dc330ce386da56a9343cf8cefebc096b7ee4c915e759f
sentry-cli-Windows-x86_64.exesha384-34878a7f30c3da8861455a2e8a8cfbd5a861649e11fe88432e9b610c83650896
sentry_cli-2.41.1-py3-none-macosx_10_15_x86_64.whlsha384-f1725bd33ea03264ad03f8a7f181b914a7bf7c1367de8278ef439a7220d31c4c
sentry_cli-2.41.1-py3-none-macosx_11_0_arm64.whlsha384-90500a935989b95ee7ed2cb42d567d6c37af7b8e001e52f206633fc9eadae050
sentry_cli-2.41.1-py3-none-macosx_11_0_universal2.whlsha384-06af1eda0937f527097e45fca46eb312a893ace871b355938634e150823d2a99
sentry_cli-2.41.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whlsha384-450aa03569d9bd3516d2f0f6eab1b3d6ceccafa9da8a81c983670dbd2cff5529
sentry_cli-2.41.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whlsha384-c9f7b5341b0ff02180c00d8cd80362b286b877189be8cd10c7ce02b84bb962f7
sentry_cli-2.41.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whlsha384-ff6bcdf8d6015353ed5b5c1e0adb547a411758c1ffec8939628dac0ffdd12c8a
sentry_cli-2.41.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whlsha384-ae2e392ccd490e9a7147743c28cba239f320abd0d5fd2401530c927e410f9fa3
sentry_cli-2.41.1-py3-none-win32.whlsha384-fefacaf32ad267f1af559167d0c62705c39fd37e8969896676839f6652c48bb6
sentry_cli-2.41.1-py3-none-win_amd64.whlsha384-83179c4cb7d1901e700df02e16b67846f4a7c79f5ac659cc45b70856c1da806f
sentry_cli-2.41.1.tar.gzsha384-ba192e7055583e85bbeeda9ec462ca8a16ad102c6921b6c25fd87deaa62068b0

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