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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.19.2-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.2-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.2-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.2-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.2-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.2-py3-none-macosx_11_0_arm64.whl (12.8 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.19.2-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.2.tar.gz.

File metadata

  • Download URL: sentry_cli-2.19.2.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.2.tar.gz
Algorithm Hash digest
SHA256 155a256fdefd22361a8c652189e56c78a133666f0f2f5d2f90c768af43caa271
MD5 2b049e5510fd3d925c49ff2e10d55b44
BLAKE2b-256 e1d5b746d45df3efbfbbf2796d318deae3264b85984194d92f923aae2a03ef8c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.2-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.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 9cefedac56af06441926141b0506556f90d31ab1e4c9a9b3ab865889daa7b021
MD5 e6c1cd661790b84e0c10f34232a20119
BLAKE2b-256 cd039a0166f88cd9c6da5122171583414a3635dec65fe1d73695a469795c29ec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.2-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.2-py3-none-win32.whl
Algorithm Hash digest
SHA256 eb102505bc24c7538c66546b51adb3935d2664dffd74025ee8be9bcc10718d06
MD5 8e6e0883448765b49cd1dc0728fa1fdd
BLAKE2b-256 019759b7a4a0a569adcf5afddd4d87a7457ced11fbf9539c44802ac26aec1190

See more details on using hashes here.

File details

Details for the file sentry_cli-2.19.2-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.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 4c928743bd24b8e4b18d35b4eb61e466f9c741bcf2b093fe3beae6ca0bf89d9c
MD5 99e0ca40259811ddc9e866e5d3b009d6
BLAKE2b-256 9e8fb1996115360f6f7a43d9d57ade4e3cadd2fb0b7dc1ef1f84fb8d4691138d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 8a4fd4ac2901af41db3f3e8135fd02d07d2dcc7d8c724ba4ab2196a5c992cbaa
MD5 4767ec16ada6e1eedd9a3620de276da1
BLAKE2b-256 b54de061ea0cce7ff13ddcbdcbacf10758258ccaab2bbae739ad20c3c8c57353

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 9bfcbf7109d112dab8e251cc12862139612e2389bf60d7ae5d050a1e54165b6b
MD5 56a7ce1426b5feb95afa04af90cdf23a
BLAKE2b-256 7dd41c58f81514fff25149b135330284021483061d3c9656a574a8445f5bd240

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 9f5879cd6721048bb310e4c6c8f98265f6264f80fa47aed1b210dcd13b95867f
MD5 bb0ecc04a071aa2f9039690bf9502b95
BLAKE2b-256 48e38e53b3ced0a02a4afcf31d1c8b84de7b23485f5f5988f119cc5a63328a61

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.2-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.2-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 56f0da9a4fa91af7b76b026242c6c0536ce8f43e95b7b73d6ff29aa7a0139ddb
MD5 f4fcf5894edf6d63a906d4189474f325
BLAKE2b-256 a8e6b119666ddea4a6068039f6e588956648480d134a8cea49e6bae89d3581dd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.2-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.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9e8c6c173a6d711590a591a9a15de7a41782b5c772aaea9b03bbfe87bcb9bf14
MD5 4c359bce6e2e3f481c4d015962ff0a05
BLAKE2b-256 e4e169d88f006cd60c1402b048cc96ad38082a93f7812f274c04963c2987f63d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.2-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.2-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 4726af26c1f93e111e29b1540982476fbcbaf09c73035dce88499f48b3d126a5
MD5 78e241c9cbfca9df8de7512f6f4bc165
BLAKE2b-256 7195fbc01b1514b356e6f428bb854bf2aaedf7dacbc3307384630f0b0df9fa19

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