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.30.2" 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.30.2)Integrity Checksum
sentry-cli-Darwin-arm64sha384-f29e81cacfa7c22229c61c00f8548a98aebea63ddfebc550b600762e6f00d364
sentry-cli-Darwin-universalsha384-e8b4049d39d3df8884f16dee1e9ce8771ce86fba376273a40803111e35ca3a42
sentry-cli-Darwin-x86_64sha384-dbcbd27dbc0cb216f58614b07897f0e3ca4df3979d5e850e3ef3242ef9375c8a
sentry-cli-Linux-aarch64sha384-93f85be33b9dd5c4317f9ac38b2739f85eae2ed36e65e23b2e6454d1ed6b9ea5
sentry-cli-Linux-armv7sha384-f807a7c8ed71f7ca9bd7fa2b3f208aef7fd1d717e4484bcc909d7f73299f8d27
sentry-cli-Linux-i686sha384-b9291f5836d781ccc020ffe67bbd8ea4507d376c2b5dfeccd3693f7f3c226e22
sentry-cli-Linux-x86_64sha384-0c2b5a127498a36078c5e66b0696f0f8ed3e7464ff821e108bf5c48cdd5e90cf
sentry-cli-Windows-i686.exesha384-678ca9d5d5d04049e2758313870c254011556a2660fe5302f94e4571b684b8a1
sentry-cli-Windows-x86_64.exesha384-ab062f558e2158a790fcd79023517ca01569fec4ef260087b08f0addc58fc42f
sentry_cli-2.30.2-py3-none-macosx_10_15_x86_64.whlsha384-9b37ee2a3294f657fa1793040d92cf4dcab03d15e397a76d3f53d4d2dbd76c2f
sentry_cli-2.30.2-py3-none-macosx_11_0_arm64.whlsha384-bfc99f032ff02d448734f1ff4c952054e872dccd9f9cacbcca9ba66d78ff2c4a
sentry_cli-2.30.2-py3-none-macosx_11_0_universal2.whlsha384-4f28e34eaf07e7b03dbbeb4931558af86edf286d7002812d4c0d5b341d2b3d17
sentry_cli-2.30.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whlsha384-dd7d6bae2179ef85dfc77597b78920faa7aca2602f736fd0e5ec66cbab909081
sentry_cli-2.30.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whlsha384-4d66fd183a8c4e7b038b59065afc8397403bd5c47389daa3d5831886ec06ebfd
sentry_cli-2.30.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whlsha384-04bfe614bb30c8f787bcd6cc5b694a163e8e52505047bc87dd5f0ab8ed9641d1
sentry_cli-2.30.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whlsha384-52df147c42404d22660aff495a878331a4d468f802ab8efff62f0b561b2b122d
sentry_cli-2.30.2-py3-none-win32.whlsha384-9039705f02f1cabfe0064613584ace4aeb54fcae6c8bc8161ac73d2358b2e3a3
sentry_cli-2.30.2-py3-none-win_amd64.whlsha384-db8bb715265a8ae9cdd65c9d1249eb9bbca28ec0e6c031768b5b0b41568029cc
sentry_cli-2.30.2.tar.gzsha384-dfdcff64eedf46cac16a6fe77c57ee8c08612760f6ecb208278e7102b2854734

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