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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.30.3-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.3.tar.gz.

File metadata

  • Download URL: sentry_cli-2.30.3.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.3.tar.gz
Algorithm Hash digest
SHA256 b9e7ce92aba24402692403db48fc32527249db41570bfa195e253411c8877f8c
MD5 e451b1fb52d72ec6f0af43c3b6abba9a
BLAKE2b-256 9fbafc9a9b6c1adef686e65951f5649b0f6b34a380b51c790a5b19c0a5d84850

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.3-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 3cba28fea4680febfc3c2ec54b39a5b15a7084a5edd843db9dfb2c5d8e70e96c
MD5 b20f88dbab1cf65c90369634afacc862
BLAKE2b-256 b90f75e2ae6d4c9477b5c415cd3d5615643f03a0a28d4d3af304bb674d65705c

See more details on using hashes here.

File details

Details for the file sentry_cli-2.30.3-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.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 2b448ec4da3bcc2d6af8aa033712a22b29011488038e93f4e339e7b1d82fa847
MD5 75b92ab1b87488465e45cabdf90ed596
BLAKE2b-256 4fccbc93580354ae7116f620b7107ef8e7fd636ba18b81d68acd9eba4781daff

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.3-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 742f221d3fdc4f403053a37bdd17f0a943e801baa10b27a12eb3ce10d4d8e51d
MD5 08cde42a441c885e7eb1cbf9676c0882
BLAKE2b-256 608aa447837abb0089359420d62ad883276477d88bcfb4e3fe617a21402c7027

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.3-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 275f543c513911c133682ed8b82b25233c660de3abba0c61e0a8839a2daded0a
MD5 67026367148e4bee2a47b262258dfd2c
BLAKE2b-256 321e7829656dd380faf73b67794797fff3f2051098998732b871928f2999d1be

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 2b3c205ddf02c16342835585f2e267eafac22f46a9f2d6e73a8f6d82b0a8b2cd
MD5 a96b94feb4a49f76807ee9769ba5f9cd
BLAKE2b-256 9c8b297fd7deeb28b88ec7065e7c1204d7770c555e73f37bbf1fff7473b20705

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.3-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 447df07b4ee099038b21c6005f6e9ae51303a8ea5cb4b1ca71a5c4f7a457d725
MD5 c9148b8e13dc0f4f54955d273347b20b
BLAKE2b-256 02adb96fd25c311475c64dd15f0e0c8d7b94c866eeb6a8a13038762faa514e32

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.3-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0aa2e9a2b5bf345614519f5f271d04b97719f66b08b1b58ad787bdced870dfe7
MD5 b59b28c06054d8031d1d5d3b77b1e39c
BLAKE2b-256 d0456d81fb831baae46809fda2128381e53b38fafdf3a34041eb76274b774bf8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.3-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 87a10128bfacd15a1031114e60823bd4c0cb44354f764e27b21e65d0bb99ff43
MD5 6acd43b5365c3cda9f792a25cc5bc254
BLAKE2b-256 782e01c25117bf05c093e070aa73b004c1cc9461e774ecc1b3e97f4aefaa9557

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