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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.31.0-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.0-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.0-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.0-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.0-py3-none-macosx_11_0_universal2.whl (16.0 MB view details)

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

sentry_cli-2.31.0-py3-none-macosx_11_0_arm64.whl (7.6 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.31.0-py3-none-macosx_10_15_x86_64.whl (8.4 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.31.0.tar.gz
  • Upload date:
  • Size: 193.1 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.0.tar.gz
Algorithm Hash digest
SHA256 ae6b6364302dfadcf38cde1d0b8ef50da867263d4cbb6cfcf2f39a69a338e0bc
MD5 bfc068702370730480ceb655210f44be
BLAKE2b-256 e5fa3c86dc1644affdf1489dd1428c1d09c5e5071693f586b2b8d22206205790

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 e06cba0092088675f5ab655c82f564208cb707efd865a570e4a8e6b4682981a2
MD5 ae643ffcc2e4ee4dbeb3c9cf66133aa5
BLAKE2b-256 6100073f73286bf65221cab16eebe0d56d99fed1a819a61080d1ea736a3df73c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.31.0-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.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 e205e9849f40577ee119ecd8e3f01df9419eeb3ac1b658beff2a21d76258d609
MD5 0c33895c773638509d582e6eb7b6677e
BLAKE2b-256 38853b7e4f185d38cbcf46c365a5aaa9bf7badc89b60e64f74ce3d008b6a342c

See more details on using hashes here.

File details

Details for the file sentry_cli-2.31.0-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.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 729139a524566f01fdb3e4fbcb9423f64fdebfc2bc29bcd6332a01c8d3ef0b88
MD5 89dd9fdc5821fdd07aa82e45947f43fd
BLAKE2b-256 7fb52ed1c8988a0405aeb8a28afa949971d4c9775e4c08616cb221895cd76edc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 c95ef1732c69c6f26b391c59dbb4392f243aa77708495436996238fc9915cb12
MD5 ba5c7f6caea703ec5bf72062e413682f
BLAKE2b-256 777baaf98b9be061a27b552da67a95a14470a389234aa6ede1a65517146331b3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 4e608eef37d706fb468b84b3878edfde458b1ade582364c4601e682522a24bb1
MD5 e8b92d499890aa4bd562b5ae49deddd8
BLAKE2b-256 3a575299a6937b9b9d2b0038ea9289467a4ac0f06d24fab30f25cab001ab1a59

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 1145f84d39c14be2f71b80697cd96d02201fba89d4afe5e05bec9208d7332998
MD5 c5f5b8f3e2066a85ed028edfaceecf14
BLAKE2b-256 2034b0661790095c9eae8f6040d5e94f6bc5d962ea913ba144ded4a235e89269

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 4cb524b70b606e1211262bf80c3845d757dade643b50871e7ec4b0ed11510466
MD5 99e46d2c5bad22b7dc3d9ee051e78646
BLAKE2b-256 0f9b2c3224dee9959d6d8b653288efd6867f9e9e19929a588283d5a5cc94dd7f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 fd85ec0e3103104395194810c68b6c222264891a2a0227949296c9c386237f6a
MD5 a3a82d7888ef58f821f478632ab91968
BLAKE2b-256 64703d8042561e2364aaf643a498bba349b5f3073bb5453362204e59b2cfdbc3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 b4760e1122ff901ccd3f88ae240475e3972e3bb909bd16bd5a2ead74dc3c0e38
MD5 6298137ed2b4cd7009b45bbcb1dfdd6a
BLAKE2b-256 15577793e65b93fefc5f45f1cc2b16a31706a2ac9d80b3ea4e97c8cde60160bb

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