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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.21.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.4 MB view details)

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

sentry_cli-2.21.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (20.5 MB view details)

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

sentry_cli-2.21.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (19.8 MB view details)

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

sentry_cli-2.21.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.6 MB view details)

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

sentry_cli-2.21.1-py3-none-macosx_11_0_universal2.whl (27.7 MB view details)

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

sentry_cli-2.21.1-py3-none-macosx_11_0_arm64.whl (13.2 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.21.1-py3-none-macosx_10_15_x86_64.whl (14.5 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.21.1.tar.gz
  • Upload date:
  • Size: 185.1 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.21.1.tar.gz
Algorithm Hash digest
SHA256 3f3a859b6e2f49339a3827f8ecbfb99ce674a53e72e1871efdaa4bcb172a56b6
MD5 1c1a474cb5880a0ce4ad213b47f1d99f
BLAKE2b-256 fa8a7237232ad328b02286c1b158f36aa08d86fddb1aa3909dd3e19839b4f040

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.21.1-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.21.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 03cfd8f5d68560188c15f18a033439c1545ee96e4b1886682e5b40ef840e970b
MD5 05312f96a14ce83ef2912ad6000275ca
BLAKE2b-256 49471551fd87e4f5e3998b9295fc91bb9fcd1b419640734c67eab0dff851169c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.21.1-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.21.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 80617faa53b5bda535d0cffeabccc354d3267c714c10ed69a993ab42b3a95664
MD5 e506b7d88cce40899628580dd7157919
BLAKE2b-256 6ed0a8b294aaab58ebf19435cdfa8a2927e100eb59b1c72670d7c38c7851cb47

See more details on using hashes here.

File details

Details for the file sentry_cli-2.21.1-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.21.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 9e67ac4912870bfa8001cd397bfa58bc87bdbc5e8e22c1064ae9e302ca30c289
MD5 262c4568c5f45a5703ccad31b4333ffb
BLAKE2b-256 9e49055dfb1920c5b8432a7ff0896c1649c89d94f579c791e9cbf77638e93170

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.21.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 7661d1c20187faef4312e6be1e5d305330e6f3de8a2645167cf47caf592c97a4
MD5 1aec003bd48b9a19140d855f6fe97058
BLAKE2b-256 a4b3c21d3889b630b23ffc4461d83a998951ad3fb8ec81dcb4a05f41b8558a25

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.21.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 969dec9fd6ecbc541bc0cd220a4a2980b767cd2c27a653c2b691ab739d28f604
MD5 b375944c483de470d3978831bb8b0e5e
BLAKE2b-256 81f24a45acf413ee70e413c93fc49bc7f385c998df60ec1ed082b988e68a446b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.21.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 485b7fc711c0d459b4dbe6c3208cfe58e3efd11f0f90a13020eeb48163a33c59
MD5 5e9a22ce877e878522250ec47be83911
BLAKE2b-256 bc735c873dab8d028be491fba447e6853a551dd89c891f077f8dfab4ef165c3b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.21.1-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 27.7 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.21.1-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 0469a6136adc746a9acdebeb2238d4a26898d78cf1a22415e97ebf1514b42481
MD5 87df1a9e502a7ea3f49664c3a344bb78
BLAKE2b-256 f0e1c82ba1befae306c98bd147b732821e34f872c2f6863b297aa6dd91138b47

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.21.1-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 13.2 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.21.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4294f3e53f7748935f346ec1a6f6e120d3e37e90f417c02ee12b0167228164f3
MD5 9c9d9887a201d88a47ba19ae9e7012c7
BLAKE2b-256 76f158b6f7fd1f18cf1463e552525d41dd5c040b05afb112edd383cccf88cad0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.21.1-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 14.5 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.21.1-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 775f57e90c2c0b99f09c5fa9381168bac5d34ccbbc45f6e4ad02d1123d83ff9d
MD5 7e130166266588bbf1dc60e863e1b12b
BLAKE2b-256 5ab1744de88b338848a9c4ed95739b939ae709054c0ba5b116b7a96ebe552726

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