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

Uploaded Source

Built Distributions

sentry_cli-2.32.2-py3-none-win_amd64.whl (8.5 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.32.2-py3-none-win32.whl (7.3 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.32.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (14.4 MB view details)

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

sentry_cli-2.32.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (12.1 MB view details)

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

sentry_cli-2.32.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (10.5 MB view details)

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

sentry_cli-2.32.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (11.4 MB view details)

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

sentry_cli-2.32.2-py3-none-macosx_11_0_universal2.whl (16.9 MB view details)

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

sentry_cli-2.32.2-py3-none-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.32.2-py3-none-macosx_10_15_x86_64.whl (8.9 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.32.2.tar.gz
  • Upload date:
  • Size: 199.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.32.2.tar.gz
Algorithm Hash digest
SHA256 e8513553029b427ecde98e8106d5dff58c4e255a338f4efe01dcf8275ce0e939
MD5 0f2e0f853dc9c536ce5f72481845922f
BLAKE2b-256 190e0215bcb7767eeedfbb93dd5dbe994556f28266e85ee6aa3ee583fd600c03

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 a7914ce26c49a2c992756a764a7d28909a9d9f86404a264478909f41cc1579ce
MD5 b75a36dac20f7d64ff9f65cd2b214283
BLAKE2b-256 9b914a82fc698653887506e79b204ef875f4704ca039e1bf9be5c717fe286536

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.32.2-py3-none-win32.whl
  • Upload date:
  • Size: 7.3 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.32.2-py3-none-win32.whl
Algorithm Hash digest
SHA256 c712476308f62373f493d4d7098139a67317e83027f33b322d5f43ad35c1a85b
MD5 62c3f653eac5ee5b5dd1766658b52988
BLAKE2b-256 8d386045ce7977100c2d9b9939fc603aea6884b099e3b8c26426faafa953273b

See more details on using hashes here.

File details

Details for the file sentry_cli-2.32.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.32.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 0d1c70bf0cc76a43239e134ae8aa7879f757120280586e72d4a434bbe3b5b119
MD5 a1c8b812ece7dbaa9aad8089773908ca
BLAKE2b-256 409cddbed776dc7c8d09452c9d6d408b07a1e93e75c35e845f9622fe9a1027cf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 fa5ac29a3a3c9ee495255955c38547ddedefa70457f506358493f83f5d45c2e2
MD5 4f04b502f8945c037831c18668dc20a5
BLAKE2b-256 6e90dab385cb88f9a210e53b567d7f8d56560c918b812fd21e048511fced0319

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 5decfcb47c199e4123b3b836a69410c10f69e13e263c0049416f08ef438108f4
MD5 17e3b4813180f5356da3e4aae40b76b8
BLAKE2b-256 4b082af1da23370c2f838344c89464f52e39fa00728a1c67d9450d654b78fb1b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 fb09585560f4835fe0ff8d6be6839291c548229ce09b48501380a868d6d7500b
MD5 978877337d88a8a279d1ba9826a0bf3e
BLAKE2b-256 1ceef4cbdb8b592aa89f8c06df16291784d657578567c470a9647dbea1eb22c0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.2-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 d8b300420e8353af1667b5e617a0a2076709ba5e17a8be2529f082c23d0fa5b9
MD5 c4ceb765070b02359e2db7385d825e13
BLAKE2b-256 50a9cd35273db26f04e9a95f7416aed7a4fcca4cbdcce878d9639d9d1a369087

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 834062564566a41b350d173bc0af8575db360362a138fc3f5ff32f2a58039374
MD5 a281ec3a79cd48acf7e0a3dc642e56ff
BLAKE2b-256 783336d573e4a5ffaa2c3bae169e82e231c33a8b639ef6420ce22367fa07b8b5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.2-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 718cac8e6512742d8a82fe0e54976686a147f89a1234be81bbfadde691738053
MD5 6cfeef6d8450d684efe2225f09ffa533
BLAKE2b-256 090c90dbcfcee0cf0a4141293c825ed935560674ea228853f5a14b024fdb0ea7

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