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

Uploaded Source

Built Distributions

sentry_cli-2.15.0-py3-none-win_amd64.whl (10.7 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.15.0-py3-none-win32.whl (9.6 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.15.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.1 MB view details)

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

sentry_cli-2.15.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (20.2 MB view details)

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

sentry_cli-2.15.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (19.4 MB view details)

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

sentry_cli-2.15.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.3 MB view details)

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

sentry_cli-2.15.0-py3-none-macosx_11_0_universal2.whl (26.7 MB view details)

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

sentry_cli-2.15.0-py3-none-macosx_11_0_arm64.whl (12.7 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.15.0-py3-none-macosx_10_15_x86_64.whl (14.0 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.15.0.tar.gz
  • Upload date:
  • Size: 170.0 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.15.0.tar.gz
Algorithm Hash digest
SHA256 757fb939b346b4571d96bb5586218b14a2d97e4f0d33eca1743e340dec38fc1c
MD5 c2f4373019e0935fc90089cfc906323b
BLAKE2b-256 c7104cc622ef357e9f7e0cc2cdb0c9726f395cdef79a40775c8239ae079c795d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 10.7 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.15.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 b5a247875052cdfd0d529b12fe9a22694a21b2688e48ea7f1e3f7e708ea091ef
MD5 73002ae05cd74b339e600d06663ded0f
BLAKE2b-256 9dd4100f8c91bb86b79bfa12bbd3fab27c16959363d354a8ca888752e4cb57a8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.0-py3-none-win32.whl
  • Upload date:
  • Size: 9.6 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.15.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 c4023d4b9b0336d2a46a41aee023de52c93dff2ce64ce0fa62adfdbdea06486a
MD5 2f6aa40feb4c20419d7c757c37bf2727
BLAKE2b-256 5056d7d5a0fab70a9b3d855070a116f19d00a77ef5d0b42ea2bc5829aaf139a4

See more details on using hashes here.

File details

Details for the file sentry_cli-2.15.0-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.15.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 92e0c086686c9939ec3e417af12703cf3683e6a78397ed41fb84b7bc5a05f18d
MD5 581cf8fb4a8eaac4a693c51b92eef82f
BLAKE2b-256 83d24064225fde117dacc6b66e4470d85f52bafda1429fea609e0ce9224b359d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.15.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 50c518df000df3f19af99ef3552f3d707bf0685b7d7414139ea1c3514940d378
MD5 06a261cb84bf217be9a5862ff1f2c3e6
BLAKE2b-256 18edd53f522f4ea682c82cc16a850bff7e55cc2b305d9816b16107df504d09b7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.15.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 a58767ce8aa67118e3b3034462315bf815a9676c3b549b98fdf020c4dd76ea44
MD5 48383ac0e6836f4723129e0458de2291
BLAKE2b-256 7ac666cfd4bcec5de627ac8b6c82dcb0540c5af12709f0ada8589758961a3e34

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.15.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 30c877ca28ae7dec2882c0b5ee638358c350e37d715de967c6f0a0b3428f966e
MD5 3f9bfcfc43f5fac2dce3c5d6f983cec6
BLAKE2b-256 f1f90471e4054def20c14f2b6c24979659e9877bd408f2e0ecc24b1e5cb5a9a1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.0-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 26.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.15.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 457056dd8968e3215a4abde78d873dfb0ce1decd721c11261d5d3760e507de8c
MD5 4fadb2ebada5e0366fbe7a7fda1bd298
BLAKE2b-256 e18327174ef548ca440a7ff66f2b0de9a46a5a7c9540dba426713f8f9c6c9054

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.0-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 12.7 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.15.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9b526ef157fb740116b386e75d86d874151339747f68b42b8018c8d312fcdcae
MD5 cd00b83ca76d264d7d6a8d6be196fd04
BLAKE2b-256 bc57d084794a59f11460aa7a84d476a6e20f876074b9e8cb0db5380f483cd84b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.0-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 14.0 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.15.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 cabac104f519663c694582545ab934b7fa3d23f666cc072ef6219da49c65f5d6
MD5 af45a65b2aecf62cd24ace24e73f5956
BLAKE2b-256 5b7417130d32754bc8916fc910b187ee9c0c836413fa108af7cdf1581f2c7591

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