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.

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.21.0.tar.gz (185.0 kB view details)

Uploaded Source

Built Distributions

sentry_cli-2.21.0-py3-none-win_amd64.whl (11.0 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.21.0-py3-none-win32.whl (9.9 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.21.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.4 MB view details)

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

sentry_cli-2.21.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (20.5 MB view details)

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

sentry_cli-2.21.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (19.8 MB view details)

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

sentry_cli-2.21.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.6 MB view details)

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

sentry_cli-2.21.0-py3-none-macosx_11_0_universal2.whl (27.7 MB view details)

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

sentry_cli-2.21.0-py3-none-macosx_11_0_arm64.whl (13.2 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.21.0-py3-none-macosx_10_15_x86_64.whl (14.5 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.21.0.tar.gz
  • Upload date:
  • Size: 185.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.21.0.tar.gz
Algorithm Hash digest
SHA256 ba2c57193a74cd3ae0c739327acbdafc5358f26dffe19ebfdd54cd539a2e1992
MD5 f63c553b4ae1a7579baf5063c91ae6ee
BLAKE2b-256 4abef4f4a855b288a32e374e8590ff8364995986917aa00e78e3230bc8247048

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.21.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 11.0 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.21.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 bac204f4f1028d73904d26b5c89c71361aab5191ad4a8794d4fb9fdcf1259fac
MD5 2f25fff12f64421b6817b7d407d911a5
BLAKE2b-256 c59468aa255298266e4eac19b48ac0ffd92a1496e3f4d2b38ddeb569699bfb68

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.21.0-py3-none-win32.whl
  • Upload date:
  • Size: 9.9 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.21.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 0ae2cce133ddb45e6341461aa541d64a70cc6dfb42e28dddd4f08f70119860b9
MD5 e1b1c9d8a0603ccf617c5f47d0f1d478
BLAKE2b-256 a8aec4ddd961d2357e9041189f3c6adfe7eb80df7fe44ef6f3525a12b3693df6

See more details on using hashes here.

File details

Details for the file sentry_cli-2.21.0-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.21.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 0c38339f0eda31c454d493691544e1a4e10d69c94363878c99b086111264f07e
MD5 2764fdad0dc37958ae020e07a631c887
BLAKE2b-256 3fecf9fe1c3e774b0f077dd20f066c1c567bd296258af3af098c1eb570c135db

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.21.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 86ca24fecbae92baef3a8456c1dc1ab1289939199c0288dfb1da885c661add24
MD5 9f11e74e4f2739b29e9ec3356896d4f1
BLAKE2b-256 94e9eabc50f80596e02b2275deaee4955133f8f647341e8432eec52278cb7ad6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.21.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 83c2cf3c8d584da88ef99669d5751f845ce7301b045b181f3fbe841ea8c143ac
MD5 1d2f26677cdefbb2eda8f31e4a7cc883
BLAKE2b-256 0646e16d331147cd2f125c5ff0e6568f9ac3246db72ef79a994c7a18809335af

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.21.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 b3d06764c6adf27d26d3065afaef5c004f7c6b5af3fe81f088dd34c36bbfd373
MD5 6dd91aac987cf84490f6d3aa397fa27e
BLAKE2b-256 7aab21548449e5cf17272778528386cad6b7ad6212e090306b60cac48b723b96

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.21.0-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 27.7 MB
  • Tags: Python 3, macOS 11.0+ universal2 (ARM64, x86-64)
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.21.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 504a6e677250ddaac6b0f10504bd455d8e46acc802224a540d2e003deeb081fe
MD5 2cab96f7b74e8d7f4ea79aeb608692cc
BLAKE2b-256 a722adfe5969574becf0f156e2d244074a5a1239a7d97b9c40e09c761b2a791b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.21.0-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 13.2 MB
  • Tags: Python 3, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.21.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 98180b182ebe7d0961547f5caf920cca7c4a2c06ba2da9d7972e5d98510b222b
MD5 c5716144f092ef6b03cec4e683700df7
BLAKE2b-256 42ec7fd4437fbfcf2100f688de22310c26e5e587337fbaa2f7d6f29868696fa3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.21.0-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 14.5 MB
  • Tags: Python 3, macOS 10.15+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.21.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 ebfc2318830d8f00a731cd535c3fdd5cce4b913e875b0946c34a4b4da6250abf
MD5 a2a39038aea911fdc2b8e8a17b466b4e
BLAKE2b-256 ff3927071ab5b8c1db1d9f47332cf45a04c4f5e643e706a79e77f54bca1fc3fd

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