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.47.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.47.1)Integrity Checksum
sentry-cli-Darwin-arm64sha384-8fe16710e3b6a377541f9697d430810b46fda5caef15c07086184427051d78c5
sentry-cli-Darwin-universalsha384-08d43e66fabade2d3b385c74f78e3be50f96846c5f8702400d7b81b3c672e4b2
sentry-cli-Darwin-x86_64sha384-02319109c31868c04e31ae3d701715dc76d57cb90569bc08ecc4ab830facbff5
sentry-cli-Linux-aarch64sha384-6ce920ff84c68d2c7b7cfd093adc35cf731adcdc5ccb2dc962505b44f31a3429
sentry-cli-Linux-armv7sha384-bc97edf7f5b776ca4f034a6d35b18934eb5fef3b4a030933bbdb3d6d38e10c4c
sentry-cli-Linux-i686sha384-a627aa2d4a985ff8d6ec4f01b27bdd411893b673c86d6446c23fbba18db80b7f
sentry-cli-Linux-x86_64sha384-6613872f1b21240fb5732be62620ef2bb40a436ce93955ca96393e6046947951
sentry-cli-Windows-aarch64.exesha384-0bfcf84f8ce9aaa0ebfa4d87f1cec47b09193e307bdeb5f5555d81fc6e34bb0c
sentry-cli-Windows-i686.exesha384-410f622253c1faa5e6991ad76790db4068db4e2ffd5e20cad1aa15343776c00e
sentry-cli-Windows-x86_64.exesha384-23f5a4d98931729af8cc46eab49ad5defc5d2567c6ce9306673200e87b0d2ddc
sentry_cli-2.47.1-py3-none-macosx_10_15_x86_64.whlsha384-c865d65f657860be544964114e4620b681c23c5444b4eb93c83ed1a9ad046f4a
sentry_cli-2.47.1-py3-none-macosx_11_0_arm64.whlsha384-ff296a37dc84b97565998a0256f737f6f0bf2399b38e231bdaee3fd8e648556e
sentry_cli-2.47.1-py3-none-macosx_11_0_universal2.whlsha384-cfda52623682cf9675e1d02b0ec2a5414677a3b88ab9f96f8f75b53ce05452d2
sentry_cli-2.47.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whlsha384-b298238c6bb9b802d9a382705b1b1f52712f6d2678f8fe2bba1f00b2a6f7a6e5
sentry_cli-2.47.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whlsha384-ee16543787bfe7657a76483a49fcb42aa97a363982415df83cc453a0ef413786
sentry_cli-2.47.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whlsha384-38238b09ec038b9391ce8f7130743749b1526e7584998a0a267996b9a2943c2f
sentry_cli-2.47.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whlsha384-3ae7a3f0b3401a8ac2071fca9cba231e9ef3e9f04c01246bfab670a4fd5b42e7
sentry_cli-2.47.1-py3-none-win32.whlsha384-9c71924d2319c7972f76d287ae1c12403a56c8c26afc22977ca741fabedbd2f5
sentry_cli-2.47.1-py3-none-win_amd64.whlsha384-dc234ab93e8596b8152ba3748638a410d436de4309dbf189b2daf6fe5a2d6bec
sentry_cli-2.47.1-py3-none-win_arm64.whlsha384-266278a7c398ae6eb69ac88346e5b3402c19c8e3c68699d9d38b5d044a209461
sentry_cli-2.47.1.tar.gzsha384-b0152b7ce21d49b3e60470996aa912c1e819f7f30b1fb2a30c60e8b1b72bbb30

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