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

Another option is to use the environment variable SENTRYCLI_CDNURL.

SENTRYCLI_CDNURL=https://mymirror.local/path npm install @sentry/cli

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

Uploaded Source

Built Distributions

sentry_cli-2.20.1-py3-none-win_amd64.whl (10.9 MB view details)

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.20.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.2 MB view details)

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

sentry_cli-2.20.1-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.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (19.6 MB view details)

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

sentry_cli-2.20.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.4 MB view details)

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

sentry_cli-2.20.1-py3-none-macosx_11_0_universal2.whl (27.4 MB view details)

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

sentry_cli-2.20.1-py3-none-macosx_11_0_arm64.whl (13.0 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.20.1-py3-none-macosx_10_15_x86_64.whl (14.3 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.20.1.tar.gz
  • Upload date:
  • Size: 181.3 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.1.tar.gz
Algorithm Hash digest
SHA256 e53673e6fbbcfb3767078763387deb87fb9f4f8a7f63016c4fd2435bec53b252
MD5 ee5026c714e4dfdbe13e048263d095fa
BLAKE2b-256 ab7e92ba55ee62729fed0fe39c7343dbe8a3b7cd9f65e5e802e65a8599eb3601

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 10.9 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.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 d5a0114d5678f838d3a159d65a6d5a31095c67026c760064071938004f576363
MD5 43f996507ccb140dfb503db07eea8a77
BLAKE2b-256 00e2c497f29724157476b6f9fd9ebdd0227736dd902b1a5371afb51d225a2e66

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.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.20.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 cabb2e46ebd4f6dbc8ee87ee1380c3a14baf46d58ab9ccd2423ebd0beeff21c8
MD5 dd2e15ea49aabb60710c61bf1798ba95
BLAKE2b-256 b9fb30f1b511fb2b74b21ac5c7749aca3f33dd8dd4cff00fd2074230104712aa

See more details on using hashes here.

File details

Details for the file sentry_cli-2.20.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.20.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 615267d984bd8a02649489193b7bf815e606e46a1dc77f4d817518f89a3c873d
MD5 e0950a407a1e20e320a3f14494a6a4ad
BLAKE2b-256 6c5d32abf09b1fe2baff8fe68c93316b09ba49b35b3dac3c91b7d9981b03b038

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 f3170d1eb89da094efd734539eb0c3154500f05dbdf143e263c99bfacda9eaf0
MD5 b770f2de31be77499fb7a7a9cbb55407
BLAKE2b-256 dbacdf8804e0e8eb0219346077c0d633ca937522469827b0631096c825c60c10

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 ac9d4775d774c98c2297d916eba51a577985ae2de6dfc5e0607447b9741f210e
MD5 b2503211195fa937896adfe2d1149644
BLAKE2b-256 b78a9d6955f3a3267dfabe43b7fd4a5bdd6531eebf8962db1c1978e515e77a2c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 896892cd306869e38dbf7b53fe0835a385b83090ab1a5c8543702fe4260648e4
MD5 502945dc2356cd05b80a7e4b35f6750f
BLAKE2b-256 ab619aa5374521da1ad3d909aa109847fa3fd8a7ae97c83e01bb2dde6641e362

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.1-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 27.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.20.1-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 ef5646e3b2028e0d99356a3bdec976f6c0299c66fb515565dc1bc27b99f2eb98
MD5 29bc73761a3a41ae2e9c93fe614e647d
BLAKE2b-256 91fff471295ac15ef43d440b8eb2b5a2de268a0beddf5daaf9c1d44efac8aff0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.1-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 13.0 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.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1e2ff2cb7721a159af356c519a3990d2a5ce831451234eec543f2da425b9d4e5
MD5 b0f9479300726294bcc9e2028d05b432
BLAKE2b-256 8ef57ba5291c5f034a168927849732f8996bffc863ba31c915c0dc99820dcbfb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.1-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 14.3 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.1-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 54b39f5fad68b78b154a329f84b23dbdd61fd811aa14dce9e4e66f7b0cb02349
MD5 02ce979d3305241dc6781badafaa4593
BLAKE2b-256 c60b0ebd298b3e50488e7c56012555c24b338958513d94706ef14e2aae643809

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