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

Uploaded Source

Built Distributions

sentry_cli-2.33.0-py3-none-win_amd64.whl (8.3 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.33.0-py3-none-win32.whl (7.1 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.33.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (14.2 MB view details)

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

sentry_cli-2.33.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (11.9 MB view details)

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

sentry_cli-2.33.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (10.4 MB view details)

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

sentry_cli-2.33.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (11.3 MB view details)

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

sentry_cli-2.33.0-py3-none-macosx_11_0_universal2.whl (16.5 MB view details)

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

sentry_cli-2.33.0-py3-none-macosx_11_0_arm64.whl (7.8 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.33.0-py3-none-macosx_10_15_x86_64.whl (8.7 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.33.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.33.0.tar.gz
Algorithm Hash digest
SHA256 c176f45bb7912652158fc374c15f73eebac15340fba27ad71fd1fbfb73313623
MD5 00f1f38e38fb3f8bda81a1b61a4997fa
BLAKE2b-256 0119b7742235ee90ef2adc1509d6c9be9d0462721ac09f51cb0a99ca6e80144a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 fc4934963f626f3d84bbcfa83b46f18e564f126dd6a32925305056766205235d
MD5 2c09af636a2688e99c5975156426ba26
BLAKE2b-256 929275f1f52a4f051c4d93edbe09cad0a3982ad2387092e6a981eec41a73cae2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.33.0-py3-none-win32.whl
  • Upload date:
  • Size: 7.1 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.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 9229be4d1cf626c2113027e3b8553293b981567f2ed6f845b22742c81dde33dd
MD5 b3135d2fb76f3320ebf291a6eac0f27b
BLAKE2b-256 f03d8ae64e2c31e180ad26b3a95d7a688b1ef2614ff0ec7f3e23245b217bfa82

See more details on using hashes here.

File details

Details for the file sentry_cli-2.33.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.33.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 032facd7ecb0f5598eddb9843f81b6f4cfb24be398ad3634a50aa6974a1645f0
MD5 bcf0aac93e689656250e4d3c380925da
BLAKE2b-256 012e629a011651f4ade2812ac94ab809df13b426e4223ed94bd5cc455c204e4f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 56663aed2486d794762680ccb15001bf2bd398bbf277779def8f8ce010bb6bd0
MD5 9afdcda0982eb72d2c8b4cf3f6b85479
BLAKE2b-256 16704155719ede75b44a22ed6d8c0dfe846ba8f9e117033c9137658f9ebeb989

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 11462078f6fae8a04a41a9a38439602997c844db2ddf44e23366a6aa665ba98d
MD5 6c64642749fc0f5dae05c06633c3c8ee
BLAKE2b-256 51c7858ba76677080fa12a8762d3d541f0954599d46d835e356c97a8a15d4553

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 ccd16ba99c87c3a3c35c0da86afbe3f270e6a4a7f0fead0178ab8fb9be7c2dd1
MD5 49ed6f204d3e686bf6a4f7c76ea84f86
BLAKE2b-256 5a087e44cdd4c09b2fb966f573fbd986f7f31b5fa3e7b70933f978529cfdd2f6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 09449eb7719111732d73629eaa5b88074074a4bc00a9dbd210f362c4736b4914
MD5 32dbeea0a4df11c6ffc76c0b57b9e64e
BLAKE2b-256 e39d95ac1cc7eaa1bb043cf1c58ecb8a2b1690903992d77fee6cdc025df84caf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ce4633a40085a2ccb81efe392e1d3993b8e8412e079fcb82d30dfe0254878de1
MD5 6313b0df7040a3f5d5b9aef2a61a6b7b
BLAKE2b-256 c669639ef7ace9d6dd3e8251f724d2670d46174fc68c4fd6d7d19a2b37a950c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.33.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 0b62610dd3ef200326320c029e10dcd0474b524643f0b5dcbe22b893c467f600
MD5 490351543cbd0f99c8c960617d33b2d0
BLAKE2b-256 62e22e55377f50aab8b418ca932333c39f513f41f38cd9efc0bb1bf85c60e941

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