Skip to main content

A command line utility to work with Sentry.

Project description

Sentry

Official Sentry Command Line Interface

Build Status GitHub release npm version license

This is a Sentry command line client for some generic tasks. Right now this is primarily used to upload debug symbols to Sentry if you are not using the Fastlane tools.

  • Downloads can be found under Releases
  • Documentation can be found here

Installation

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:

curl -sL https://sentry.io/get-cli/ | bash

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:

curl -sL https://sentry.io/get-cli/ | SENTRY_CLI_VERSION=2.33.1 bash

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.

If you are using sentry-cli on Windows environments, Microsoft Visual C++ Redistributable is required.

To verify it’s installed correctly you can bring up the help:

sentry-cli --help

pip

New in 2.14.3: sentry-cli can also be installed using pip:

pip install sentry-cli

Node

Additionally, you can also install this binary via npm:

npm install @sentry/cli

When installing globally, make sure to have set correct permissions on the global node_modules directory. If this is not possible in your environment or still produces an EACCESS error, install as root:

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

npm install @sentry/cli --sentrycli_cdnurl=https://mymirror.local/path

Or add property into your .npmrc file (https://www.npmjs.org/doc/files/npmrc.html)

sentrycli_cdnurl=https://mymirror.local/path

There are a few environment variables that you can provide to control the npm installation:

SENTRYCLI_CDNURL=<url> # Use alternative cdn url for downloading binary
SENTRYCLI_USE_LOCAL=1 # Use local instance of sentry-cli binary (looked up via $PATH environment)
SENTRYCLI_SKIP_DOWNLOAD=1 # Skip downloading binary entirely
SENTRYCLI_NO_PROGRESS_BAR=1 # Do not print the progress bar when downloading binary (default for non-TTY environments like CI)
SENTRYCLI_LOG_STREAM=<stdout|stderr> # Changes where to redirect install script output

When using sentry-cli via JavaScript API or any 3rd party plugin that is consuming said API, you can also use SENTRY_BINARY_PATH=<path> alongside SENTRYCLI_SKIP_DOWNLOAD=1 to completely control what binaries are downloaded and used throughout the whole process.

If you're installing the CLI with NPM from behind a proxy, the install script will use either NPM's configured HTTPS proxy server or the value from your HTTPS_PROXY environment variable.

Homebrew

A homebrew recipe is provided in the getsentry/tools tap:

brew install getsentry/tools/sentry-cli

Docker

As of version 1.25.0, there is an official Docker image that comes with sentry-cli preinstalled. If you prefer a specific version, specify it as tag. The latest development version is published under the edge tag. In production, we recommend you to use the latest tag. To use it, run:

docker pull getsentry/sentry-cli
docker run --rm -v $(pwd):/work getsentry/sentry-cli --help

Starting version 2.8.0, in case you see "error: config value 'safe.directory' was not found;" message, you also need to correctly set UID and GID of mounted volumes like so:

docker run --rm -u "$(id -u):$(id -g)" -v $(pwd):/work getsentry/sentry-cli --help

This is required due to security issue in older git implementations. See here for more details.

Update

To update sentry-cli to the latest version run:

sentry-cli update

Compiling

In case you want to compile this yourself, you need to install at minimum the following dependencies:

  • Rust stable and Cargo
  • Make, CMake and a C compiler

Use cargo to compile:

$ cargo build

Also, there is a Dockerfile that builds an Alpine-based Docker image with sentry-cli in the PATH. To build and use it, run:

docker build -t sentry-cli .
docker run --rm -v $(pwd):/work sentry-cli --help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sentry_cli-2.36.5.tar.gz (201.6 kB view details)

Uploaded Source

Built Distributions

sentry_cli-2.36.5-py3-none-win_amd64.whl (8.6 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.36.5-py3-none-win32.whl (7.4 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.36.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (14.5 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ x86-64 musllinux: musl 1.2+ x86-64

sentry_cli-2.36.5-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (12.1 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ i686 musllinux: musl 1.2+ i686

sentry_cli-2.36.5-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (10.6 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ ARMv7l musllinux: musl 1.2+ ARMv7l

sentry_cli-2.36.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (11.4 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ ARM64 musllinux: musl 1.2+ ARM64

sentry_cli-2.36.5-py3-none-macosx_11_0_universal2.whl (17.2 MB view details)

Uploaded Python 3 macOS 11.0+ universal2 (ARM64, x86-64)

sentry_cli-2.36.5-py3-none-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.36.5-py3-none-macosx_10_15_x86_64.whl (9.1 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

Details for the file sentry_cli-2.36.5.tar.gz.

File metadata

  • Download URL: sentry_cli-2.36.5.tar.gz
  • Upload date:
  • Size: 201.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.2

File hashes

Hashes for sentry_cli-2.36.5.tar.gz
Algorithm Hash digest
SHA256 b8bc2c8f40a9d8bc899e3b532f130efa2fd7ee98321f5bb0940b0b8edb3a5910
MD5 09bc8cc2cda6c26d838872434fa507cd
BLAKE2b-256 77fb74ea96bf7da433468e487f8446011c5bd9cc858a706476c5b560acf6054b

See more details on using hashes here.

File details

Details for the file sentry_cli-2.36.5-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for sentry_cli-2.36.5-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 70318949c1c7dd6b8e7fd38e0c78fc65645c812ac72affbb12030984e0239d8e
MD5 130216c92bce3fdaf7e13d9fb299b41c
BLAKE2b-256 10f932ed267568cfc5b2a81a78c4e9b62b046092632f828190d00e95eab62616

See more details on using hashes here.

File details

Details for the file sentry_cli-2.36.5-py3-none-win32.whl.

File metadata

  • Download URL: sentry_cli-2.36.5-py3-none-win32.whl
  • Upload date:
  • Size: 7.4 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.2

File hashes

Hashes for sentry_cli-2.36.5-py3-none-win32.whl
Algorithm Hash digest
SHA256 d15673ba973c9e593e274d411c816a94623def6f8b0d3e3c598226d0891d9db9
MD5 8a5a6ae8e135c7564c987d05d925ce0e
BLAKE2b-256 621e2c4b84e43b933c1135d17ad4bb1e058c023b968846bf308695b96d87ce1e

See more details on using hashes here.

File details

Details for the file sentry_cli-2.36.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for sentry_cli-2.36.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 6e5a3adfa194b9bc72ea5c9d413af56ed255b7a2d03c210877fd5c0e6fd05deb
MD5 9f2c23b13e3fc23dfd08ad1e6111fd30
BLAKE2b-256 53b21782be41a743ac928c66d33bef80234a20b47b6b77b68ef970b636913c76

See more details on using hashes here.

File details

Details for the file sentry_cli-2.36.5-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl.

File metadata

File hashes

Hashes for sentry_cli-2.36.5-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 d023e674d41b12f894267fa307069b1121e945f049ad6ad941eccc91cf21a829
MD5 39e761ba9e2a1d78a97c204e09bb35ae
BLAKE2b-256 5103ce0d50d05f6384b084f534fad81d4b0c307aede906fd0c38c05c40738c05

See more details on using hashes here.

File details

Details for the file sentry_cli-2.36.5-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl.

File metadata

File hashes

Hashes for sentry_cli-2.36.5-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 16fd5e82395c104f0fb71012296f07c7b51f0f518ef7835ef639faf7663cec18
MD5 39ca9a7ccf1c9b78a2c1d70e247cafec
BLAKE2b-256 6a711947e5a9f6acf87725d1c83a0bb467214a010e52bb9910ef1ea465d8b317

See more details on using hashes here.

File details

Details for the file sentry_cli-2.36.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for sentry_cli-2.36.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 f432ba4c172dc6db6472d71d8ea28d44a9ad023138fd4bb17f2fc830c164a077
MD5 1e98a988e2ef1379419a040dd0c5ca6f
BLAKE2b-256 0a4d6ec0c30f3755b91b2816e01f7b6705f8839f40eb12df2f72f4f60e00ef0b

See more details on using hashes here.

File details

Details for the file sentry_cli-2.36.5-py3-none-macosx_11_0_universal2.whl.

File metadata

File hashes

Hashes for sentry_cli-2.36.5-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 b1f45774116f55ad05cc9f4dd327aa7766b109c8202634b843dd64d86a4cf492
MD5 37aca126c4cede7690f4c1a0f5378156
BLAKE2b-256 40016c0d39d55974a15b6623d9d95e668062de2110ab5e19c642fa9431550e6f

See more details on using hashes here.

File details

Details for the file sentry_cli-2.36.5-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for sentry_cli-2.36.5-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f89999505f9675169ebd86ef412a5b18b2cb2aaafeda0a0ce82a9895ed9de745
MD5 4bcea53c49ad99774197fe07cf430b3a
BLAKE2b-256 861d99f4483f5c5d6840796072d84cf346f2c2c38ff123908df54b9150e2fa1b

See more details on using hashes here.

File details

Details for the file sentry_cli-2.36.5-py3-none-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for sentry_cli-2.36.5-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 835959f382e57159ed5a871ec475d75d62e12d03092a2ae728f7cf0bc3e6d4cf
MD5 08de21a981bd029ad739e3e55c7809bb
BLAKE2b-256 cc0c75318645ed6762a834a8c9eb50ea2414ebd0adcb4a3f65112fa8c2b9c656

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page