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.

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

Uploaded Source

Built Distributions

sentry_cli-2.20.6-py3-none-win_amd64.whl (11.0 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.20.6-py3-none-win32.whl (9.8 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.20.6-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.3 MB view details)

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

sentry_cli-2.20.6-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (20.4 MB view details)

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

sentry_cli-2.20.6-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (19.7 MB view details)

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

sentry_cli-2.20.6-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.5 MB view details)

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

sentry_cli-2.20.6-py3-none-macosx_11_0_universal2.whl (27.5 MB view details)

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

sentry_cli-2.20.6-py3-none-macosx_11_0_arm64.whl (13.1 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.20.6-py3-none-macosx_10_15_x86_64.whl (14.4 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.20.6.tar.gz
  • Upload date:
  • Size: 181.6 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.20.6.tar.gz
Algorithm Hash digest
SHA256 e710f978fac5bd488fb94623f7f864eff2838ec958f30eca4d7d4e1a1f856a5b
MD5 b8d763f79e471d698eb14a7e51162f59
BLAKE2b-256 cb9b1dd903fab94f6e099eafa0d8a068354e1f4cb6ec9cf4565b0673c7c4c5c6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.6-py3-none-win_amd64.whl
  • Upload date:
  • Size: 11.0 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.20.6-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 2280737854b19054928eb88a6201757c40c7671ec6d718f36fbb56f91a5c767e
MD5 2fe023dd0dca1866d81e6eadfe29d202
BLAKE2b-256 ca5d27d01f01234857fd65334c83fabf37957f785ca50cf1f2a74b6b688f817b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.6-py3-none-win32.whl
  • Upload date:
  • Size: 9.8 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.20.6-py3-none-win32.whl
Algorithm Hash digest
SHA256 6d271788d6d50bd1b8d2f68ac802468966ff441c0e9c9d54b0713b4fdedcdacf
MD5 5f030d0b90a09c4a62c25b22e35649ff
BLAKE2b-256 42cb5fa60af278dc290c3b0a2fdadcd60e5af7d07105bb7dec8cb942e6983222

See more details on using hashes here.

File details

Details for the file sentry_cli-2.20.6-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.20.6-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 c2c1c8bf0ecfa809e93c32b666e68dde1b98fdf071def18bb15a80b7be7e1660
MD5 fc7a44009ff3996b4e54bb39053e4d39
BLAKE2b-256 75a896b5d16e62207872889aa0f6a42a553285c2d9c76a0c2eba3cb91be2c180

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.6-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 a192b4f55db24fcd197a1c5d3a7a3bb5d4ee07d016221c3fa2adeebaff9c5531
MD5 c393c61fcd0b3885ed8de956a9da7285
BLAKE2b-256 3e99c336e1f86d9d6679b7cbc0eb951270e5fd59d9b32a07b07815163f355e1c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.6-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 20b98274b479592305e9a535445c842ff61484b09907deddfa4e2cf47d6cd0a4
MD5 5e3136f3189fda0c88f2da0f91a0be2b
BLAKE2b-256 fa8236b85b5e55bce074469d38d779ed640c69c476085c6336d579bf767056c7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.6-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 938bc00de57da809608eae07fdc6613532041fce20d50d679e09436e6e73bd78
MD5 898b7bb8df33bda7bb8c17bf1ce6b3c3
BLAKE2b-256 cd44f8e13575f95c0c8e7fab949ac5fbd19554ea0115874ce2207d88ab2b7487

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.6-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 27.5 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.20.6-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 6b202e90e85670fc950502f5cc95a8b0603bfa37403ef3899d39b5b92ccca135
MD5 242c9f6e8fb24ee12c224d29cd6b255e
BLAKE2b-256 2bb08c8e864a57ee813dbd1638968f239e8cbe3b547d9a059753d2ef76b213d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.6-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 13.1 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.20.6-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ea1c09a5772e7b0692ade5ee744e904566b25534ec1b18bc8a802fcc0dc7b9dc
MD5 429b550e530feda16ab9b0c617da1e76
BLAKE2b-256 cceb551d6848068f99438cb28c6caf4716f3531d7f03ee62f52bd7920340f8dd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.6-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 14.4 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.20.6-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 62a6f2d74f930ab0c974faae65cc7e9d01b91bb77c902a19633c55df49e8ba3b
MD5 b0450770ac625c212507120f1a4b66c2
BLAKE2b-256 9b4419743477560af7be30dced5b5019a0d6718b22ac3702d0caf9bac8e84ff3

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