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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

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

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.1.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.1.4.tar.gz.

File metadata

  • Download URL: sentry_cli-2.1.4.tar.gz
  • Upload date:
  • Size: 177.9 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.1.4.tar.gz
Algorithm Hash digest
SHA256 c8031ed676125ec3d3c76328ba01ec9b49f2e1a3127a5436aec4b0fa49dc3a26
MD5 2ad53fe7e08d8be29c3ef864f2a4d929
BLAKE2b-256 2e1f6b41bbcc0656b82c6cf755b9ab1f879748dd57c201b5ee4beac0dfef0c13

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.1.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.1.4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 e2c5e4d01177adef972465d517cc9769a7cc2c94cb1c551e40324c52a7526896
MD5 9e74326a1b8d4ced19740acd8dde0d17
BLAKE2b-256 1488977159e548b369e9e7257a0096d9d6c48d76907d16bdfdb08b8ffbe04860

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.1.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.1.4-py3-none-win32.whl
Algorithm Hash digest
SHA256 8e77361daf891e4a9e950026ee4a448d17fc0ac639028fdd7c115e5504841f42
MD5 9644fc124fc2b23727118515f8df8d78
BLAKE2b-256 ae2db168febaa4ad3355fac3c9085279e1a0bbb1957cc2c79d84c06fa0718130

See more details on using hashes here.

File details

Details for the file sentry_cli-2.1.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.1.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 3d53b254ed6cfa85b8322ccb8bb387bcc4dc46f3bb303b4e2895f526c4269e69
MD5 fe53984197d752ee4d59d4ed4ad6d3ee
BLAKE2b-256 07f5ae7af3619fd38369a8c22164b91e73babcb6bae4564309266a139ce5d46d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.1.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 9b8f39d6bf8577b4375878e5cd3abcda06e1aa8937dae54d5b4618ba85ab4f01
MD5 c2cb2a11dc342fe5090edd36240452b2
BLAKE2b-256 7f01dc2b54e04cdebebda397e22a604a4a8fe8a10e4d506892cbc67ff6a63400

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.1.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 5ba98636a31d0b952344ae64c8828d4004a0cdff957328e47e75f6d6d7f1ffaf
MD5 429b4d87b5015834a8836d55fefe84dd
BLAKE2b-256 8f31b20d339701baf518590460135025a94437cbb49d8d880c6b203fb82a04a2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.1.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 0095c52197009273919c07835ed53e98047d543e5c021304e7ac5229d052a565
MD5 a8fe9cb66e3ada9531c77d08161e0e5b
BLAKE2b-256 6e71bb50b717e7cdce24e077e867be8b021adf74094eb31a399db82d589a76c5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.1.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.1.4-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 0c62488778f66f0bd960bd7fbd6655a3bf54df7fd427d6f822d8dc12e4262227
MD5 2c455a446fb073ce8ce18da127c67083
BLAKE2b-256 17df7ea38040f59e2408135ad4045b5892b24b9a33b14ba0d0101b87c7bac4c6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.1.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.1.4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9d531f3d5bdd343ba96efdf4eb707cc13e261b20e50099ad161728576da7e83e
MD5 b5e1debbbc9ccfceb08047678023b8b4
BLAKE2b-256 9a6c53f74a1fa3b78612866a9f55c4655428349d8d6a6cdf48efeebcb4b82122

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.1.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.1.4-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 c98037b93bd25e7530b7d6e6f9856b80eee3a2cb1696e1440f397eeed9bdd325
MD5 e7558173de16eee2e809671e7b1d26dd
BLAKE2b-256 b64b3e42e7e4f875c08525f88e3b0afb995dbf2ff808427fe0c93527c99366ef

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