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.0.4 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.33.1.tar.gz (200.6 kB view details)

Uploaded Source

Built Distributions

sentry_cli-2.33.1-py3-none-win_amd64.whl (8.5 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.33.1-py3-none-win32.whl (7.3 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.33.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (14.4 MB view details)

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

sentry_cli-2.33.1-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.33.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (10.5 MB view details)

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

sentry_cli-2.33.1-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.33.1-py3-none-macosx_11_0_universal2.whl (16.8 MB view details)

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

sentry_cli-2.33.1-py3-none-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.33.1-py3-none-macosx_10_15_x86_64.whl (8.9 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.33.1.tar.gz
  • Upload date:
  • Size: 200.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.33.1.tar.gz
Algorithm Hash digest
SHA256 44a8f2373ae3aeea39a448e0caba24e076a66f83a4603f6fdee40b0eb2187f6c
MD5 7900c3d782555756587e027be17d8fd9
BLAKE2b-256 10adf8aebdf13ccf19099d96ac136edd92295027264cad9921d267e532fa71d7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 6b34edd5d5867e24d8f18c1206c2a4f56442989bb5597c288c080f28409843fd
MD5 da5f6f140fef6abadd9028dec85e0148
BLAKE2b-256 1c27181649d3284107c24491346a2c6de0216840782e77436ce8d8e2aa6975e8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.33.1-py3-none-win32.whl
  • Upload date:
  • Size: 7.3 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.33.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 b6e15c80627807a1b127f704bab90f56f4074b6bd0344628825ebf4cf79e2284
MD5 df4f63842eec8ca531dfb4a4196267d1
BLAKE2b-256 7f0cc145b1ce2fa9d0969bdb4fdfc9798a3bba3b9e11855ed8bff5ca004baa43

See more details on using hashes here.

File details

Details for the file sentry_cli-2.33.1-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.33.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 98db834929f591e38baa54da1b8d4b440b3d20c3d2235dbd8dab3a25a0eca953
MD5 ef71851f59c8eca7ed86f27313d85e42
BLAKE2b-256 294a4ae644854d2c727a11516175b61aba99a39bb02970a7ebd21761051b2a66

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 6486c639f5029a0533947e669bb361740760a4ffcb4aebdda1fddc6a23f3c35c
MD5 b3f978f6dfa319a99b73e45b4bc6dfc8
BLAKE2b-256 2e01d6e304a5abc18ebdefb9b95e0dd55e38d8ab619c85deea7899b79203ab23

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 8e22db3440b0bbebfa907e14a7eadfaaf82f5e7c0d62ea00dd91d87baf93319b
MD5 155610f31d327b817fc8b8518f6de6c4
BLAKE2b-256 5fb22328bf80a83ba969a863e700e5373fdd872b2ce70160ef6ac7d5b08f9637

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 db5e1010a5b6b89c14c0b8b75ead34f326893d3600bac46d1e4ec887f548282e
MD5 a4d18487b1ce3e187393bf8401718c16
BLAKE2b-256 b9d1803efa89cfa248aa95790732eeafdc30463196cdd47a505d96b0fdbe734b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.1-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 bfee86bf8954c40668e68cfd3203e7e80800dedb49778e17c17aa8042b440136
MD5 9c16ecbc69b9d724cbcb0dec1dbe367c
BLAKE2b-256 0a34d5d40d9b81560db98c52c4ae25ed31375e6695953e63617ba05f089fa455

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7fa413af9b1ee990b5ccfa4c80b040063bcde5c626d391c639cb032a178fbb06
MD5 4aa21d01ff57e1b07fd14cae44845d27
BLAKE2b-256 29d3ab515bbe390e11b05ef526d2f74210f12801781081eb3f271ffc7d8047fd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.1-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 ab9df0fbdcf94548ec058fa24ae678bf2366aab21a0e28901a5d64e6ca6d876d
MD5 e376f9e0dda87ec4c043635d62b29907
BLAKE2b-256 5a4268cc640d43ba9bed39c35048939cdc7d99e9919bf369356bf53de1754a86

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