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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.30.4-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.30.4-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.30.4-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.30.4-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.30.4-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.30.4-py3-none-macosx_11_0_arm64.whl (7.6 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.30.4-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.30.4.tar.gz.

File metadata

  • Download URL: sentry_cli-2.30.4.tar.gz
  • Upload date:
  • Size: 192.5 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.30.4.tar.gz
Algorithm Hash digest
SHA256 dafbed76d7e04548174a68a22df7590d1de5fb67d241efcbea7590bece2bf566
MD5 8d983228cd3d4a696dae39faf8e923bc
BLAKE2b-256 5f3aa59ace5120a28db43a9a51ca61f1ad577e8ec55166997d4aaa04b8cc41ce

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 b44bba24e6b6250ca517a2423f2aa1cb51ca55d45e4360497d69a54c0ec0266c
MD5 37aaa25562e2fc55d217a45d5ea217a3
BLAKE2b-256 ea7827a930141c1f1be6c2bb712de09303d5d01b91b1f59a12313371b0aa6697

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.30.4-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.30.4-py3-none-win32.whl
Algorithm Hash digest
SHA256 882640b604476f00eb2c5af4d9ab65f59f79d6ed0b07538f3c6873410a2e6f8d
MD5 5e89d5ce2e94cc5c749e73a97bb13b96
BLAKE2b-256 423c5d1a7ec57b4e7b6bc041ca4fefe47c4da78d7d02432b2b63e737f1ecf3a7

See more details on using hashes here.

File details

Details for the file sentry_cli-2.30.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.30.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 b71bd9fb35ab07b3550990bf4144033231a03e7850e3b390e88a2709c3d2646f
MD5 6eaf3a9ad1cb6d07265c9fd0cde3192f
BLAKE2b-256 c4b6994f51486cefc32bed56fa4b5381cba18865ada4d6a8c766bfa0f030e78e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 1c3d40d4ec0bc57c1a15c1b0d333a8bb25598658423746d1ce94b4951485f32e
MD5 71af8a405891f35c6830f3b91bc401cf
BLAKE2b-256 891cf3ba09992485f0374412963ed7f6c7ab64e752807ca167b394ad6cc04f4c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 ba3cc218dc6e774485e4e1b00658b1bd6601d54496f88ab05b46a9248d2662c1
MD5 306c78b8a80854e8a58fbc68bd1bccf2
BLAKE2b-256 456327ef548e2786ffe59c1c80bdb5207d91e73b06207ff593060a096178de4d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 bd9002a45e284d925802ed8e0ed0f1b7338a619f70cd3b355270de44ed0767c6
MD5 d5394133849b8b7dd319a914af884d71
BLAKE2b-256 dd578c17a440d55c4c70f1088baa634cceb52d500b95b04e8e7d600db0aea01f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.4-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 b76215435d77440b7550562719bd87b524e462c41c26bdb5b741874c5216ba4d
MD5 220c2182c1f1d4072a1e05f65c391520
BLAKE2b-256 8475e59fe95f87b0be777ce076d45b7ef7ff600f72953ea03ebc5bf2a765af3f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1ecb84db0d26916819ce472ee34196a58d4babefef0ca6f2b0abcb0d6914c28d
MD5 90a4ebad284a2cd45ee73c10155c6778
BLAKE2b-256 f0b5a6ca05d935cfbf24a3a9f757cb626da7ebaff358cbf0c15586b7cf080b86

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.30.4-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 699c94a2621728256a00109e2fcb88f43fa3178334ee441234ca6928d96b5bad
MD5 204bd7004326003596ff4a2c197de4a4
BLAKE2b-256 04703907866124797c9a8a25c14326510782ff1d60808063c83212d2c778b629

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