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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

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

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.15.1-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.1.tar.gz.

File metadata

  • Download URL: sentry_cli-2.15.1.tar.gz
  • Upload date:
  • Size: 170.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.15.1.tar.gz
Algorithm Hash digest
SHA256 a66a73f8ade50ee750bfcddc77e7d93e2e364fa74d5bb0cad697eccdc516defb
MD5 617d7f10ac14b8e4261cc4235d874171
BLAKE2b-256 d700c006c1e8eda33c7698e1a1f5a8ceb6271919261b171b1b7ee4f6e75270a6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.1-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.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 3ffd67a2329d0f1bed60ad6b37b6e9bbd66c3ac00cf5414b4b6af9275407ab4d
MD5 a054554a4394ac7ae1e11759aec69c91
BLAKE2b-256 e4ee4bace117b797cb6f019ac4326061765d540807a70b135831068f5ae7a02d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.1-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.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 6988859f10d7e95febd2b81427aec92d54a02a53a773a65285a084268cadab50
MD5 3fff18ff1c002a063d1bbff22482186a
BLAKE2b-256 bf4ac34a587068ea32cfba76d299c475a887edee472a1946602fda632bb8e308

See more details on using hashes here.

File details

Details for the file sentry_cli-2.15.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.15.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 3bdfb2141b9e18b50b2480780221270ad0ba43ad5d9e375ab602e0f7afae0dd5
MD5 b28aa6b11fdb82d5f3f0bedf97aeb6e8
BLAKE2b-256 50ac22cc2a44cfca2832db27dbb02f3badb70787db052fb984039d7917e46225

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.15.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 05966ed8fc6963b351836c09f4e631627715e2ed58fe16fb11746f96f9a603e8
MD5 0da264411d5b450ec1f0186e13013903
BLAKE2b-256 3736a510168a11f5d9fc930864d36464069d48c1a1f226dceef999b34a3207f2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.15.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 5debf22fcc3e91ad7e5ced1225f0b444fa194c2793bf1fbd44fa8e1210322af9
MD5 be63277315f5a5922aa26948f6d0616c
BLAKE2b-256 b1bc89c92f8a8155ed73048b835b2ba3aff30f8ab2673484bc0ffb22b1c4e601

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.15.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 256fe86e893bd0eb802e067860a80ce400ff1bb11974cbc2937f8d0a95a153ce
MD5 90ad1d64c9a5f180cd88a4ad97d1502b
BLAKE2b-256 a58d8b2251173cc6c5592d388efc951de5fbd289e295c6e80d4a343ca340544c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.1-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.1-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 268c1309c321668fed5f45ee8cc5d63e357bd0e9d05e8cf416a9ea43f5687631
MD5 dcf77d8fb566c8931977faddc929c50c
BLAKE2b-256 3ab88f80996f2d660d359a772af48ffd7bcf9f0a7760edd37b3ef86f8edf2b9b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.1-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.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7d5f71f3576f2259909adbd765e9be2a6ce0b8f151d9bdc7fbf7bbc0d77785ee
MD5 f5f8ebf988f479b58855c1c4c7d144dd
BLAKE2b-256 1bb10f18a8bcbc75a77cd9b041cdeea98da30f8fdf54574f036fdf6943331c07

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.1-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.1-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 e32b079e407cc390570e21ffcd90db1054805a94779bd55ffe5342b3eba27d3b
MD5 21902e134820b640561c4dd26239bfe7
BLAKE2b-256 d23fed13f1a7108b838aaede37cb6ba9c30189fb34877c5a92c1e999b45ccc02

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