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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.14.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (20.9 MB view details)

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

sentry_cli-2.14.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (20.1 MB view details)

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

sentry_cli-2.14.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (19.3 MB view details)

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

sentry_cli-2.14.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.1 MB view details)

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

sentry_cli-2.14.4-py3-none-macosx_11_0_universal2.whl (26.6 MB view details)

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

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

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.14.4-py3-none-macosx_10_15_x86_64.whl (13.9 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.14.4.tar.gz
  • Upload date:
  • Size: 166.5 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.14.4.tar.gz
Algorithm Hash digest
SHA256 5e050a6e644d4a824b45a05f4e69586ef11c15d59215533c51252fedb7f1a52d
MD5 05e2bb8846cd444cb8294b54dbe4dd5e
BLAKE2b-256 f841174b9da6ffce3a7645c851bbdc81dfe88dde7eecbc20619e1c4fc77e108a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.14.4-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.14.4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 f444dcd0b7811c01c2e30309f27f5c6aedd3c861cf14378325ae8ab3f1889599
MD5 24ab618c6ae42e3385aba95d69713145
BLAKE2b-256 66e474df3519e7c651abfebf8f94335d772f31b38de235ac9622c00a2501a078

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.14.4-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.14.4-py3-none-win32.whl
Algorithm Hash digest
SHA256 df40ea05377fe4113a5770723112f55678273d7207615045138e5a8f1e83d55a
MD5 117fdbec3512a4e184765ca399e21f95
BLAKE2b-256 e7142e59c56154a1970f08f9a9675772740d5efae5ceca4cdb3e0fa741e2fd80

See more details on using hashes here.

File details

Details for the file sentry_cli-2.14.4-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.14.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 56d7c99605fa18ccf1d64fb34a53677e3861120ce42f839fb0b2dcf972ab8601
MD5 f67bb1361ce8c0d367250641a2777120
BLAKE2b-256 01817c76abbe498f75efa3c9c615d75fcc7de28802f77c79fe9b53f960e5d8c5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.14.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 48bff16fd456af66dd7c5e6feec3791ae9b9ce5549c171fc6cf4c1bab60ae733
MD5 5b8a7d5d9160c7a874696decbf62c017
BLAKE2b-256 57261c26e1f36424d85708990df9ff7aa4067c35ba00529f4cda69ccb9cd62a5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.14.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 852153dcb993ad9f9a273e3a466641edab06d70d835aea4543c184db26723b70
MD5 b572a7be6afe8da051b3549c444f3510
BLAKE2b-256 27bdf62130fb6d88bc1bec47cb7ceb55eb6a2f086930e6b8ef2617d97da6d40d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.14.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 ea8795f5a81874e44a2d1134438b02dc0ec383cd1075ef45066961aaf88ade42
MD5 61c1266824bf7fd833b24d9817e35686
BLAKE2b-256 05ea0f1bb43bf53267457586241fcca739c9f37367f207b72075864594bb30c7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.14.4-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 26.6 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.14.4-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 44d552a3054c4efc124ab8ad6af551b48bf9544cd8366c24a107cdedab0c45b5
MD5 e22dd7cdf0a471201ca5cf841eb230a7
BLAKE2b-256 f432d799453c9ad40eb17a74c341a5278db37a222d17fff42c0d6ced0b6a17bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.14.4-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.14.4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7f6d20d59e0c5e1b9ea486a3fd627ccb8c41984320b9fb1f8a933c7882dd245c
MD5 32a8867de48e33dff85fac6964002c68
BLAKE2b-256 6411accc49402c8bcb55531b9e5dd18d350cef12a720497680be8ade08bef0ac

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.14.4-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 13.9 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.14.4-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 484d615c8cd5a6b2fd8db23b146cc79312d622d8c77cff1b2c354fd8f7fc9405
MD5 9690677d4d7d8124730c5ebf629c26c9
BLAKE2b-256 8e6ebafc905811a6b044df56c66484069075f0b89cca3c6d2d2cb966bdb5c592

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