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.50.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.50.0)Integrity Checksum
sentry-cli-Darwin-arm64sha384-e06af6e72fd23b6d5a6b7baaab61767cb71fc6fea486c7f5498a08bfcd58eedd
sentry-cli-Darwin-universalsha384-fa057524abbbd85e960960c5520074837bea11aa7c09602f1489c24728e24d45
sentry-cli-Darwin-x86_64sha384-a055429e5e671d35ccc020934dd0a2ec0572efc47656be29b4315f388653ec98
sentry-cli-Linux-aarch64sha384-d9bc23158a30b4987dfc36494375aa86f1adcf1fb3dd2acb1245d3a4fae4179c
sentry-cli-Linux-armv7sha384-970f08daed2654ea6733609ba4dbfbfc1b9beec630daf168f10dde57dea84d54
sentry-cli-Linux-i686sha384-29a843be810a8987216ce46c41edffe2e21813999888a4bdf5034ed3223ba541
sentry-cli-Linux-x86_64sha384-89b1b1cd10c16d817a70ee5bb6673ccdcc48936648f6f281b8d576a3044430c9
sentry-cli-Windows-aarch64.exesha384-bf9cef27c30dcf06a10954dfb4933f4515d09398075061503a684da1fa9020f6
sentry-cli-Windows-i686.exesha384-724eeacac294d2e902ec0f9444f47e1454d7d3743931a9af1bac298f908d6afc
sentry-cli-Windows-x86_64.exesha384-090fdd6d59c88436c0de98d91d930b4be2905e60f4f948396750fd33340fa62b
sentry_cli-2.50.0-py3-none-macosx_10_15_x86_64.whlsha384-693c3e38067d6e8e5d841e0bf331721b550761be748afedc4a90700de15b44a7
sentry_cli-2.50.0-py3-none-macosx_11_0_arm64.whlsha384-67bbf400dd0cb405bef3a572a57a8a3d807eb82466d1d20525b5d810b3cbc21a
sentry_cli-2.50.0-py3-none-macosx_11_0_universal2.whlsha384-daad02dbfb34a76c0ae83ef45c56ff9ea18f410118062c0920d762cfa179d6d1
sentry_cli-2.50.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whlsha384-680dbc2d8ba1cb77f04d700b664040bb7f01df6dc4b5badc126c8b02719c9c8d
sentry_cli-2.50.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whlsha384-ac476c0657dfef6cc10deecc52bb8df44784620a999af92a5d058e4f448f3546
sentry_cli-2.50.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whlsha384-c49069f948730c90b23c0a80add731e4257a136ee2c9c3855078b9e649d6934e
sentry_cli-2.50.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whlsha384-d4e10efa0b880a93bdf5c77c42c4dd5e27edead2d27ce84d85a342b27e6f8a2b
sentry_cli-2.50.0-py3-none-win32.whlsha384-adcddca94ed17878d89cabbf4cc5aef6c57e8f9783b0276bb09c799c707622be
sentry_cli-2.50.0-py3-none-win_amd64.whlsha384-a171d08bda51e9f2e5552232457a33abc46197d0a4c3072b678ab3d5e39aa87d
sentry_cli-2.50.0-py3-none-win_arm64.whlsha384-e2d30ad9d686995e5b7c4bfbe641e8641b7eba10c0c68d61f2649f295bfc993b
sentry_cli-2.50.0.tar.gzsha384-51aac229187cdb71e34a2fd361a131383085ddd5a1f3222829577aa6ae1fb3be

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