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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

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

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.31.1-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.1.tar.gz.

File metadata

  • Download URL: sentry_cli-2.31.1.tar.gz
  • Upload date:
  • Size: 194.3 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.1.tar.gz
Algorithm Hash digest
SHA256 719ec9eb64213fb1f8dceefd4da6c77c5904e01b2cfece332825f31caff6040c
MD5 646fe6bdf1c8e15b57d7cc81626ccf6c
BLAKE2b-256 be95f90bbbc514790cf0ecb406010eb753cc0e39482a94fa6fde0f4661450c1c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 367911a4df0150ce74a0e798d614ccca9a672e2c2dc727c172b0d989e3942a57
MD5 4dda6229972e59a343a9a21eed57ebe2
BLAKE2b-256 f75a3d09090c8608d0f44f280b38e5c37bda9a560606aa36ad2dd3b4d1cd7401

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.31.1-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.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 027f83da7eb04329442f7030e04abb2b436d9998fcec63f0923e6171918b0ba8
MD5 bd1983946ecd9cbf673625ecd30b3cba
BLAKE2b-256 f453f7a85ca3510e4e8002fea3ea9c0431c7fc1c20e5886a7bbf674781c2e8f6

See more details on using hashes here.

File details

Details for the file sentry_cli-2.31.1-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.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 c6ffe9435714fa4eed9ef4e34f1ade36cb4558da2c87cb0f8c1e9986f1ad9b54
MD5 30af0f6c58b8410b5eec9eb6737d1dfb
BLAKE2b-256 ccf573cbc35086b6f2302b0c60b2156dfbe5ca5bed96763f53b9929544b1725a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 358fddbfb514d7a9306f2124da954004e364de9807491e4e0f6aeed641e8a560
MD5 9fc2fc16193a5380936ac2c4a8c2e09c
BLAKE2b-256 df14d0c7a0bf4e1ad7a4748495c328fb220d616c23e10e625aac195d1051a8df

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 ffe67520f28ee8a20a5a5eca7b83c9262fd1a11ea7f7ee7fb03d9cabcc85e9b4
MD5 ceec9135dc6cd25403bef68995f311ad
BLAKE2b-256 eb6e5a5bc9e40d2ce27064ce69ded24859f3b29afdbe68de02a9658f3b90bf40

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 157b38c7676ef0dcb7f430e1d2113991e6927d1b499e53699633bf39b279c96d
MD5 7ebf118e2c0304d53c1d4307e0351bde
BLAKE2b-256 dff8f9f8249cbdceab4b563c0faaddfe62679401427ffe81b48d52a2a84c8cf9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.1-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 1967f1ec80d1833204d98774642d3cceea5dc1f700db7d5c835e195936072ce7
MD5 f6829286ea0ac1d12bc07ee9c55c1267
BLAKE2b-256 68bc2ad4b98f1e4491a475f45a6eeed44e27daab1bbf14747b19d3ec63ca84f3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 60e0ba14c153473ffb1cfe34058368e90d30c90180ce1b5a68d3ff52a471d95c
MD5 d0118c4da8870c05865306c73f0a4c8d
BLAKE2b-256 e0d96ca30aba4855c18456505fc261f6c19b78b7424231b419411d9a2879da9a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.31.1-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 98ce4d6abaa77c5e5fa855d9554a40a2b8d3fa652b84e528d2411365f39c13d0
MD5 fc5c1d4b6487bb7aa14164bb730900d3
BLAKE2b-256 081f3293965dc0c1d86a37343569af45794d70be86b09f42bcbfc9eb8eea0088

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