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

There are a few environment variables that you can provide to control the npm installation:

SENTRYCLI_CDNURL=<url> # Use alternative cdn url for downloading binary
SENTRYCLI_USE_LOCAL=1 # Use local instance of sentry-cli binary (looked up via $PATH environment)
SENTRYCLI_SKIP_DOWNLOAD=1 # Skip downloading binary entirely
SENTRYCLI_NO_PROGRESS_BAR=1 # Do not print the progress bar when downloading binary (default for non-TTY environments like CI)
SENTRYCLI_LOG_STREAM=<stdout|stderr> # Changes where to redirect install script output

When using sentry-cli via JavaScript API or any 3rd party plugin that is consuming said API, you can also use SENTRY_BINARY_PATH=<path> alongside SENTRYCLI_SKIP_DOWNLOAD=1 to completely control what binaries are downloaded and used throughout the whole process.

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.

Update

To update sentry-cli to the latest version run:

sentry-cli update

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

Uploaded Source

Built Distributions

sentry_cli-2.31.2-py3-none-win_amd64.whl (7.6 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.31.2-py3-none-win32.whl (6.6 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.31.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (11.2 MB view details)

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

sentry_cli-2.31.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (9.8 MB view details)

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

sentry_cli-2.31.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (8.8 MB view details)

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

sentry_cli-2.31.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (8.8 MB view details)

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

sentry_cli-2.31.2-py3-none-macosx_11_0_universal2.whl (15.8 MB view details)

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

sentry_cli-2.31.2-py3-none-macosx_11_0_arm64.whl (7.5 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.31.2-py3-none-macosx_10_15_x86_64.whl (8.3 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.31.2.tar.gz
  • Upload date:
  • Size: 194.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.2

File hashes

Hashes for sentry_cli-2.31.2.tar.gz
Algorithm Hash digest
SHA256 5c8b9d3e56233f5c4c15dfcf43bb30aa3038f676bb4d1a7374f14f2f685505f4
MD5 b9284abf8f55656c86e4fde5b7ebd79d
BLAKE2b-256 b5f98c62fc1477f7916b4023857e28bb72e227f3727c7fa3c24e55e280855aae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 b047bcf1c0c73e154760bd1040e0136b481962f85610020238c0e049898223df
MD5 640fd4a796bf077f905f951db05d8c5a
BLAKE2b-256 8ab92fde9435929b789b267dc72a2fe5fc17cf689f223ef52f9caecc67179168

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.31.2-py3-none-win32.whl
  • Upload date:
  • Size: 6.6 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.2

File hashes

Hashes for sentry_cli-2.31.2-py3-none-win32.whl
Algorithm Hash digest
SHA256 ff5585354ac5069036528a9a81d5aca640d75d52fab193601f26a7455a22f518
MD5 ca9012e03d0a67175a9aa4e09c681a22
BLAKE2b-256 3858215e459d6ce4a92375e4d9fc31282ba02fa31c28a421d22699727b1d4765

See more details on using hashes here.

File details

Details for the file sentry_cli-2.31.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.31.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 4f1450613af65eb96e8c69bcb8ba8e6dae73e614c7c2a2063cae3994c3e6093e
MD5 846b1d8ba912398ea663fefc9e3b483a
BLAKE2b-256 b2c29ce1801c92781e5b3191ca441ccb5b7e410ce79443028754f3094ca73147

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 fd048a1dbcd6c5ac233e2aa95c537e565017857b03b07be423c1735f43b0a651
MD5 18cdc996efbe0a6e9cc33f7b2d49da98
BLAKE2b-256 7022d3b597ebee014742346f7a83414f777494953bf4c1fb78b8d31ab0e49cb0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 9b2bebef2bbe9dcb9637f5cfeeb9c889758a5f6f6792ea562e797252ae7a92a6
MD5 4a89d72392a902c6a98f019417685762
BLAKE2b-256 543bae9c5f329012ce9e87ac576a54aad43eb506ee35c14c0eb2d0ecde2e6168

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 cef1ec3acf17fdbe65995e6542381d534f66c630ac8f51c34617f47122cb77fb
MD5 54fb1319430e28ac101142273af4e768
BLAKE2b-256 0169e11202d391979d6b4a50dce28c45c25465a99aef2d91202b60f1aa54a516

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.2-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 fc692969fc6e34084f5e8f851937d8e36085311a7adbf9e397df7513a9be923e
MD5 fb05c580a5c90370a59719f4cccbe842
BLAKE2b-256 1cbc9eecf615fe19f329c7b5ca49e87aa7c15a041c956fd696458457d1ef340c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f54958e3638344403a9abdf7521b353712181554e46a76bfb9df6d4719f5664c
MD5 2aee458643f7651c0e257ac690b41c5e
BLAKE2b-256 04405f7d2d76bc0b451d4939080e762159c9bd3d5a6fb903d7e5cae3903b64fe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.2-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 fbcd2fbe80c9ae0627f53f10f9941881c253930db85a0db98ba71104145c3677
MD5 31bf9a0d703dab046f82206a522fa9cd
BLAKE2b-256 de2f06b20ffaa583b678dec06edfc724c29f7fa608b2acaaf48166f2489e5832

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