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

Uploaded Source

Built Distributions

sentry_cli-2.30.5-py3-none-win_amd64.whl (7.6 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.30.5-py3-none-win32.whl (6.6 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.30.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (11.2 MB view details)

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

sentry_cli-2.30.5-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (9.8 MB view details)

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

sentry_cli-2.30.5-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (8.8 MB view details)

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

sentry_cli-2.30.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (8.8 MB view details)

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

sentry_cli-2.30.5-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.30.5-py3-none-macosx_11_0_arm64.whl (7.6 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.30.5-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.30.5.tar.gz.

File metadata

  • Download URL: sentry_cli-2.30.5.tar.gz
  • Upload date:
  • Size: 192.5 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.30.5.tar.gz
Algorithm Hash digest
SHA256 97206b7b987b93f5838cbf631c4a36c5592b4811a297b7c8724bb1323b9117d6
MD5 bcd33a9b934dc99bb26dbe70d2e7f116
BLAKE2b-256 e7c0e08f704989730885821ae8377120fbc5e1bcbdb985464d395ec0cf3e409c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.5-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 25b8c051ee41d42a4c3083fb8e39bb5821e4d2fca6da7fd21a0b85943eb99545
MD5 b6c5ea15c5be7c219d495098602327ce
BLAKE2b-256 5129159d5a2ab08ef598f2b1059bb0e3d3c5a22513fbec9073df81608b57a819

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.30.5-py3-none-win32.whl
  • Upload date:
  • Size: 6.6 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.30.5-py3-none-win32.whl
Algorithm Hash digest
SHA256 894f45fa5e935f9aaa153f65869c75e0704a59c681cda569ae56596c0c18a864
MD5 02cb198a99e3bb26d27a9f1d5b8425d7
BLAKE2b-256 ddfc6538d295595bce8aae8b64cf7e67d066fd629c458ef5c5d201ee43f89309

See more details on using hashes here.

File details

Details for the file sentry_cli-2.30.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.30.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 e195d4f2d38c093b8cfe33f97a5769fd49765857d652c1e8356aa1b0d6e81c1d
MD5 90be7902d5068ae6448c9d788d6a2142
BLAKE2b-256 89974f84e0042552792ad2b1b58070e71809fd629e27b35e31e6b6c003147dfd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.5-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 b1a640ce74a91d18f15a750d9ef839836bb398a492b2e4c1e489aa62788a2ae4
MD5 45c385835152634c72118def745f35e5
BLAKE2b-256 946c46e9654bebcbc89c79215acab2f6f299ddb1b730b8fd1904ddab199ed01c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.5-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 b549949ad15dcde5ed20fe0f87097b1db487e881c231f556eb1b739a39358a25
MD5 949154b25af63dbe63f268fd3ae48f29
BLAKE2b-256 01ebe0bb27ddb691e2845b5bb391112c1add46d84f698e414278e63f55c6cb20

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 95aa4258e12b6f6571ca1f69163978ce74b2ac3ff3ba3e6ad6975fc7237f3771
MD5 5199dde522aac31a22923f1a8cb03231
BLAKE2b-256 760dd1b9fd1fe9fae1a2ac16ae3fa2fd7e3762e3eab2903da2dcbc1f40227e69

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.5-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 7d4bc3684af8965364985a2870bca0bc77681a77af2db9c4e3e8312da6a43400
MD5 31e3ff5a1095ffb55e5f5c1689850ba8
BLAKE2b-256 6c380589e4e6f6b44b78327aa14f87800737d534334d0dd3784d43906601d0df

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.5-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7e0326b2383efc073dbecca2c54442dd05dba0527e31f28a48c86f3ebe2b8383
MD5 760bb76903fd3582946f6cad874c35cd
BLAKE2b-256 a55d42ed1edf66aab8e1266f1d3a8af900b6703abf779d7b8f96146efdd16536

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.5-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 f12eea221d60cc01b0db352a4231a2b242a0ba7395e46ff3df50b505e5675c67
MD5 fefbed777cb5723fcb8801f4c471f197
BLAKE2b-256 4a918edc3aa71e7845c78e4bc555516ca3cf6431b9b31e674dbce2783f089fa4

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