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

Uploaded Source

Built Distributions

sentry_cli-2.32.0-py3-none-win_amd64.whl (7.7 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.32.0-py3-none-win32.whl (6.7 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.32.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (11.3 MB view details)

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

sentry_cli-2.32.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (9.9 MB view details)

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

sentry_cli-2.32.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (8.9 MB view details)

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

sentry_cli-2.32.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (8.9 MB view details)

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

sentry_cli-2.32.0-py3-none-macosx_11_0_universal2.whl (16.0 MB view details)

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

sentry_cli-2.32.0-py3-none-macosx_11_0_arm64.whl (7.6 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.32.0-py3-none-macosx_10_15_x86_64.whl (8.4 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.32.0.tar.gz
  • Upload date:
  • Size: 198.4 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.32.0.tar.gz
Algorithm Hash digest
SHA256 73472b5e6795af61a947ffe5fbd881f285f64e95a3d2564575eb32739480ed90
MD5 026fdd3fa5f11fe5af2bc747bc1ed80f
BLAKE2b-256 802393bdc928656f38fb140c6137c9c873678aef700e8f8d779e5f58b245604d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 da4c709d4e1cd02434317bf5bbee2fc24a0cfa0cbd4112a287a81e0812b34117
MD5 f372ed4ed65704c80a0eedaa5f2bd4c9
BLAKE2b-256 a8bc055c02bf2497875bc9c773c3b2f2ac3b27352c4c96aaaa2fb43f013f036f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.32.0-py3-none-win32.whl
  • Upload date:
  • Size: 6.7 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.32.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 67ca605c99b9c1bcbba181825922a2d70ab8b2d6d2f58e88f27fa95b16ec0c63
MD5 ba4d2d108ff931b1938b12ebd2e71fbe
BLAKE2b-256 a6c884eb92d852955efdc74bef15f1e7a60fb5d6ec499ad5e01606cc751023b2

See more details on using hashes here.

File details

Details for the file sentry_cli-2.32.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.32.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 fcac649039bd172a80bc005a5208b927ac2975ff7bc98fc2c42d47063e0f316e
MD5 804d8598b42868f23b9b9e1343007a9d
BLAKE2b-256 55b918e8ae530cb2ea609ee6ab814fcb66d8835b8abcedb46a33193dd195c4d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 a8b31e8545a027d1ca82cb90585eca48c15bfbf77b8cea05b8f7f3ec8b92046d
MD5 225e8d1a1e3f74f70926e1dfbf492c65
BLAKE2b-256 9097ad2f55aaeaaeb9bc684d012f1520558b186cc7c2161e95386c561ae595ac

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 2f0231205fb421994fe6e3917da76689935b6724d06658199022d56e61e70cd8
MD5 c38af133854b43d483066611255cb99e
BLAKE2b-256 c36c65bde06485c288ce67de606cbe83e234d6871ef4d05e03cc0b63c7019784

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 5256cee71e8a52924412b7a971d5d00d43d3de14364bbb2b1e2f8fd60397d14b
MD5 5e5f677845c074e83f7832150467d6fe
BLAKE2b-256 f06f91d9d93f511c8adfb9dc480f481268db504667af7139a4c81e312869ca87

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 5f3c2146d2556c922ca916aa17e88c4465c52accb00c3ba7b747470beac7ad7d
MD5 c5eca4ba7af600b87029fa133ff4db12
BLAKE2b-256 288ef7faafa8c96300b3e5d2b354c3070e97ebb8a9ef8d167ad0b31e238606ad

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 cd28f218d5cbef18ac442d4adc3216e7a7dd02786fb9c06be283b71e7c274213
MD5 71d97148de625f751d0a96408c7e29f5
BLAKE2b-256 2ec564d5f1be69994b19f37003d3e8eab5945223698dcc08807388d58555b05b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 5b497da1bcaa2b4c25e1651c625b500b9a512a4a8340fc116c1d09b95eca200d
MD5 285c1bb5eab28023ffb846dba3e6a801
BLAKE2b-256 fc5bcf458b3af2af49d7c5a3e6c181a570b7e3e28494bf8c4db6294d3fdd14a2

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