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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.30.2-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.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (9.9 MB view details)

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

sentry_cli-2.30.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (8.9 MB view details)

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

sentry_cli-2.30.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (8.9 MB view details)

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

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

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.30.2-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.2.tar.gz.

File metadata

  • Download URL: sentry_cli-2.30.2.tar.gz
  • Upload date:
  • Size: 194.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.30.2.tar.gz
Algorithm Hash digest
SHA256 dfdcff64eedf46cac16a6fe77c57ee8c08612760f6ecb208278e7102b2854734
MD5 dd41412135847d5e68a2bb67cc91c154
BLAKE2b-256 f3e129a0c47ccfeb71d378f9187a237082dbd4226a9479837949ee7b3f797850

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 db8bb715265a8ae9cdd65c9d1249eb9bbca28ec0e6c031768b5b0b41568029cc
MD5 967e3c2c9bb0293fbc5eb2925982a86f
BLAKE2b-256 dd519c7668a7e0f187661e3fc9c849b380e286d9f020163abee845228c7a6517

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.30.2-py3-none-win32.whl
  • Upload date:
  • Size: 6.6 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.30.2-py3-none-win32.whl
Algorithm Hash digest
SHA256 9039705f02f1cabfe0064613584ace4aeb54fcae6c8bc8161ac73d2358b2e3a3
MD5 0d2c8b84ae3aa5b6fa2724a1746b15ea
BLAKE2b-256 543222f1a94761b94187678233ef117e02de811f6b244ef23223fb84b51b70c7

See more details on using hashes here.

File details

Details for the file sentry_cli-2.30.2-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.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 52df147c42404d22660aff495a878331a4d468f802ab8efff62f0b561b2b122d
MD5 e5d1f1bb5e6c8b701fdebcd78a4de27d
BLAKE2b-256 4bf1844e424c5e029f238ddef7d154bbe917922515bfd0da69dd1afde97c2d38

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 04bfe614bb30c8f787bcd6cc5b694a163e8e52505047bc87dd5f0ab8ed9641d1
MD5 f603852d7a8d62e2c975573dd2e4a3a6
BLAKE2b-256 ef48f9040b1a18b62a2631f6beaf51106c184b367f7e95ec659f6801d4c3f317

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 4d66fd183a8c4e7b038b59065afc8397403bd5c47389daa3d5831886ec06ebfd
MD5 3e9433056ad5bda083d394d993634698
BLAKE2b-256 2bedbab9f20bef4b09a76be0f4eb6c6959530f8b976603da69acb72c8ccaa082

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 dd7d6bae2179ef85dfc77597b78920faa7aca2602f736fd0e5ec66cbab909081
MD5 32a19f687eaaca81a70be21fc5f8fd37
BLAKE2b-256 a9205969250bd7b93101f1a71b247e65922f5110990d447588de7672d0f10154

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.2-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 4f28e34eaf07e7b03dbbeb4931558af86edf286d7002812d4c0d5b341d2b3d17
MD5 0c5faaa41445a4156f20eb04733282cf
BLAKE2b-256 6869411ffd315800d761e935ca5671af9090e2775759748f3471e0922b9810bb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 bfc99f032ff02d448734f1ff4c952054e872dccd9f9cacbcca9ba66d78ff2c4a
MD5 5a6ff32a73b4a0b5ef804a7fa05a019c
BLAKE2b-256 8fd5389302892e70724c95ab09810a221895a99da8282f4d331c893312a40f9a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.2-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 9b37ee2a3294f657fa1793040d92cf4dcab03d15e397a76d3f53d4d2dbd76c2f
MD5 278ce75de28d991d0693ee42034e3a2c
BLAKE2b-256 6be6f41a0ffbab99fb320bf9f95ef09ec28cb80ae74ae1a50025c67d098f1238

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