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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.18.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.0 MB view details)

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

sentry_cli-2.18.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.18.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.18.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.2 MB view details)

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

sentry_cli-2.18.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.18.0-py3-none-macosx_11_0_arm64.whl (12.7 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.18.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.18.0.tar.gz.

File metadata

  • Download URL: sentry_cli-2.18.0.tar.gz
  • Upload date:
  • Size: 175.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.18.0.tar.gz
Algorithm Hash digest
SHA256 181adac73e818732dafd53b6d173096f55a6b2d1fad280e7cad024b100468994
MD5 6a9a55396acd88fc5a376aef13a9ea60
BLAKE2b-256 6a572bc0796eb5137edd75f2804f56735ca70ab553261325226ecf8031a75d7b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.18.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.18.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 315d48957d1b84c900de4a316b292305eb533daf54eb704fdc8e60450fa8975a
MD5 f881550e0d45b13488257933ac8666ac
BLAKE2b-256 3dcb3063c1b3724609035066fba3f9c6766421fa97a7ab4b0fff62963bcdecbe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.18.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.18.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 b23b3b2acee56a89054ddcb1c9201bba6112ade4afd803e7d12efc441e737850
MD5 2e09a77ebf227f5c40a5d5810c893fcc
BLAKE2b-256 d8eabd4fd38f9f45105159d6cc783dd02028f565e4e822502641f3d6aee52a28

See more details on using hashes here.

File details

Details for the file sentry_cli-2.18.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.18.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 0ee892058c5bae84e573f8c477a944bda18e18e540b6867fc649873f7f599d3a
MD5 071b5cf8948570957a3ba25e3392dd82
BLAKE2b-256 fa63f9a76e79ce4727f19eb0fd981f05e31213f2cbc330dcf85b261872394ddb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.18.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 d93501cb48aa4af37e4e8434193f76ea17f62f3cc87a57f21d8748cf876db9d8
MD5 c4213175cb5a5a0b3a62e1193c63502f
BLAKE2b-256 78bd5d5d69d60bf7f8d0a827bd93c7c2feb7812ef46eaec01b73e646523f5ed8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.18.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 d4f148319971012b7589de6a2f8be8cd8152f0c429116c351f9a6bfd7015ae25
MD5 2617ade6b06347d62124695c2bc77a21
BLAKE2b-256 f012abd27ff518f9f972f498fdd9bd8d6ff89f0437472fcc578f664709b00418

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.18.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 1592658f43d13f9d529f303beed017b076e86d896351c63e2267f0a8edbfdea5
MD5 b171f8dc956cc35d0ec9d38d5157da0f
BLAKE2b-256 fd7b0384f3c3e18557232a2ee6ac7a61c56703e2e6031c839a78ab6237eb8f31

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.18.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.18.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 50da0f7e82eaf3a397fe22b9a424e5ff5171b99e66700f03edf9272a7d876bcf
MD5 6fecb41f0c5b66fb7b9070bd161b0f35
BLAKE2b-256 f2026e58c19c8ea3ff00bf07f2636e2b738fdc56fcd7e7b622b0dcc2b43c31c3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.18.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.18.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e6752f6a22059648cd56699e67ee7f8f450992e058f20e274c6d140d9373373d
MD5 22b75f5eb0e7c7ff6bcdf4d2fce940b9
BLAKE2b-256 d553b4ec9b7198ae6ee06192151cb17647546c5c8c587978637a46529cfbcea5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.18.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.18.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 b80bf4d45e1191a05b0e8ef2fb1873cfbe94a06725b90abf2dd303a29ddb63aa
MD5 14c49179251fdb98f553900da40b6f3e
BLAKE2b-256 aba889b3f138887629fd1ceca311b60475c2f07da038048b4373ac8c5a7aa41f

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