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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

sentry_cli-2.28.4-py3-none-win32.whl (7.2 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.28.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (11.9 MB view details)

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

sentry_cli-2.28.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (10.6 MB view details)

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

sentry_cli-2.28.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (9.6 MB view details)

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

sentry_cli-2.28.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (9.5 MB view details)

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

sentry_cli-2.28.4-py3-none-macosx_11_0_universal2.whl (17.4 MB view details)

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

sentry_cli-2.28.4-py3-none-macosx_11_0_arm64.whl (8.3 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.28.4-py3-none-macosx_10_15_x86_64.whl (9.1 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.28.4.tar.gz
  • Upload date:
  • Size: 194.4 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.28.4.tar.gz
Algorithm Hash digest
SHA256 40f39a1c18c90fe574da527ffc9cccd677fb5d88f8cd8065799b531ea0005ef7
MD5 6297f14d84f501188936a277ff269a30
BLAKE2b-256 7bd64e222dc87ea969be6bffb4014f3d3dcc0251d20214c58faadc86338c3342

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.28.4-py3-none-win_amd64.whl
  • Upload date:
  • Size: 8.3 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.28.4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 d97a54644bcab35acf578da6902184834ea1dcf942e46be7b252e42a6cebb8e8
MD5 9627a15b9462d2af192962ad719553e7
BLAKE2b-256 f9c01e3ad10deb7a246db8830df6536a0caccd060fb5ca0ffa5f90d818eb43e6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.28.4-py3-none-win32.whl
  • Upload date:
  • Size: 7.2 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.28.4-py3-none-win32.whl
Algorithm Hash digest
SHA256 5fb0610345632875a8eaca43f30bb347ed0d4d3b07642cb291319950cae64557
MD5 400c72505922b400622fb9dd35bb613b
BLAKE2b-256 d2c3d0e600606ca9ba1566f30f1a94964be918e2d237d7c7b8c01b851655b3d2

See more details on using hashes here.

File details

Details for the file sentry_cli-2.28.4-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.28.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 c11a2ac6f9de860d85df21527799dd3e208875fa093943e8616c21a59c87b786
MD5 502d160eb998a349e2fb5cfe6763cd71
BLAKE2b-256 8827ceff693475d9d961b95336c09c712ccbda93ffe2845b2358b60d5f5ffb68

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.28.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 c659f22fef71ec505196cbdac48ff4e355dcf766e57930904b0d95dab0e54ad5
MD5 ba4a740e034543d7dadf3201cb99d10d
BLAKE2b-256 3e26ea5f8f001f7f9b2c50bd20e5571950c2dd17c74acc22fb463904a6e90211

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.28.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 b1f06c5381a28f59881b29eb6d9ba4be23dade12010cb027a649e6f029f56b41
MD5 581e6eb983ba7b483c16decbf2bb0e3d
BLAKE2b-256 8d9c0bf52f46cb5ab0a5ba2c09a86a7425c578bd15b598458faddf5dfd25d431

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.28.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 ec467704f27084f11198b591a85f8806e734f6f2e7ddf0cbcbe19b4d14a39953
MD5 35918db9090ca611f3b8bafedb4b83d9
BLAKE2b-256 0b64b1459bd6c02a1553696dd229644126d6c71dcd6ec85e59aea280bce1c28f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.28.4-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 17.4 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.28.4-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 64779d1484c78a92c395abfc80b972ee3f118a3b6be0335eaf53bdd3a2b4f834
MD5 7a4054ad734c53af4bd39742e9041415
BLAKE2b-256 f17ef9e5a415c5c024390f1708dd2321d820b26c2e9df4095a4ed2a9c7b90eb5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.28.4-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 8.3 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.28.4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 186891382d6811b32f4773be586cd6b2b5999810cefbbdd3442101127958ad23
MD5 188acced0329170d3a4e074212471a87
BLAKE2b-256 ca52fa57a94719fbdde12d7647de63ab5463c309b8c3f2cb6cb60215f4132c71

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.28.4-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 9.1 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.28.4-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 909b7c578e59e5598880a52c7cd6151482f658d6f409b9e88d9cf40d0f9577d5
MD5 82f477e0bc1177ade3baabe083f3ee32
BLAKE2b-256 652191a7d54d29cf44f40323a243f953320163e601971f1f46e5fcbadf3fd367

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