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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.19.4-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.19.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (20.3 MB view details)

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

sentry_cli-2.19.4-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.19.4-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.19.4-py3-none-macosx_11_0_universal2.whl (27.0 MB view details)

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

sentry_cli-2.19.4-py3-none-macosx_11_0_arm64.whl (12.8 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.19.4-py3-none-macosx_10_15_x86_64.whl (14.1 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.19.4.tar.gz
  • Upload date:
  • Size: 178.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.19.4.tar.gz
Algorithm Hash digest
SHA256 9701d8dd43408dd719266af52d0356e5914275566fea0de8a54151d4684cb4cd
MD5 edfe8c38b11234cdbe205ce7035dca9e
BLAKE2b-256 fb9d82e9313e211ba5ae41451996fef80719b9fcb1b92a915d4652b45b15e1ef

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.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.19.4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 632f2565eaa935a8b9b7a5160f4861878fcfcd63a8c9a6a1ac9fca142b77aae9
MD5 608528213fe62813116b1b03bde83e34
BLAKE2b-256 6386fcd73192828a4c56423aa28b40870669fdcb547db1e97019055519082499

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.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.19.4-py3-none-win32.whl
Algorithm Hash digest
SHA256 58f4ec9d098c09b65eb97ef0d1b7cc8ea63f3180fb2dde0af64eb3545fa2cd8f
MD5 5ba09788325980dc9832d6eeb369323d
BLAKE2b-256 2ee34b8cc7d0e68c8f0f6a21be29b15b10de684b1c000ad431eb06e48092616e

See more details on using hashes here.

File details

Details for the file sentry_cli-2.19.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.19.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 743a0d3acb1ac159837b88d12895e3801899bfd7cb6786755923c92f0e0c8ac2
MD5 2a910f04fed814758275cf470eb89e1d
BLAKE2b-256 1d3e56b9e4b0837a750abeeabf867dea39bd7abd0dc7c1b4b745ddc0bf24f77f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 8d42611973152e72367f6a98478a1bc151bdcba38a20f673f70e232cc6e4d568
MD5 5d4be743e47a38c2b4e9334f64a978e6
BLAKE2b-256 9e4d91ed389971de237c78fb2ed0f89880841a1be660469fcc782504172bc915

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 7080d2f62f940fee2c90d103d6f0308a24f3f7b47ae88991e6582a40be953652
MD5 917865970e5a41526dc5412e2950b006
BLAKE2b-256 6ffa85c331ca6d1aa333137cec247bf3d4b3b5ed26f1aa8ff6ebc84e93ecc553

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 2a9b8a472496ff84426f5dd42501b61441da7b3eed9a6b6671c43faa8110825e
MD5 278d11d4c8d62bd7f85c80c5f8b5195a
BLAKE2b-256 b0a4301d1a5e556e49ca497c9df1407d3ad5faa8c202a1d8dbde7e6349abb94a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.4-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 27.0 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.19.4-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 4fa9f9148a12cf4c29c9e8c64e455ec951e3ae76cdc8eec2091ab8a0fbeacfdd
MD5 8bbce9f98f3e70993380ac645a1453be
BLAKE2b-256 0eac30e993e184fd10f1eedf6ab94cdf20970ba489ef1782ee586fedcd964e79

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.4-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 12.8 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.19.4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 182270c105f00adae7937a94d2461179a923ae5e3bc4c8217bed8d3847e64bd9
MD5 08969b6f32d8eff434941caa0d826159
BLAKE2b-256 8a38b7b525530e9b8e45bc0fdcae90d7228c2be9bc526278c25c7fe23acdb6a7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.4-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 14.1 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.19.4-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 622a938088a9333b8142d8684e2994cf5620094534c246c12f5bd326fecc9af0
MD5 baadb9c2abbe3a8e8623f2272707d01d
BLAKE2b-256 f1f00ac9b709a80eb74d037be3aa6e2b4b4104dab97dce670b789b91a2c417ac

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