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.

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

Uploaded Source

Built Distributions

sentry_cli-2.20.7-py3-none-win_amd64.whl (11.0 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.20.7-py3-none-win32.whl (9.8 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.20.7-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.3 MB view details)

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

sentry_cli-2.20.7-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (20.5 MB view details)

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

sentry_cli-2.20.7-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (19.7 MB view details)

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

sentry_cli-2.20.7-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.5 MB view details)

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

sentry_cli-2.20.7-py3-none-macosx_11_0_universal2.whl (27.6 MB view details)

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

sentry_cli-2.20.7-py3-none-macosx_11_0_arm64.whl (13.1 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.20.7-py3-none-macosx_10_15_x86_64.whl (14.4 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.20.7.tar.gz
  • Upload date:
  • Size: 181.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.20.7.tar.gz
Algorithm Hash digest
SHA256 5d8be5aa8a2c2557d41e5f06f4bab07224c991ebc97f9fcad7d482d516815d1b
MD5 8b00bc74a0b6c71aee733ff4995038a6
BLAKE2b-256 2e5f5d85402ebd342dfe901d2bdc73534bbf22183f9d1ea040cecc3398a1ba19

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.7-py3-none-win_amd64.whl
  • Upload date:
  • Size: 11.0 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.20.7-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 02968ddde7df8036d260f74f8fa9a28e56b7536ee6a96aa53dbe36b311f468c7
MD5 99e60a0e4cd6bd1257af32b2323d8716
BLAKE2b-256 f800ceb6ba24748ae0fd6b082646273a0461762c63731cdcf9cf68aec10e6836

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.7-py3-none-win32.whl
  • Upload date:
  • Size: 9.8 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.20.7-py3-none-win32.whl
Algorithm Hash digest
SHA256 441a302b620ab8dd6e6dd8a1936f4ea3ebaf83c49b0cbc1d542471faae3bbb6a
MD5 7f6bb15770cd06951f2246c45fafefe4
BLAKE2b-256 d4c3ae0186c35fc7c531492e7a1ec245242e262eb7d847a0ad3cdc0141984a11

See more details on using hashes here.

File details

Details for the file sentry_cli-2.20.7-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.20.7-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 4d4c4843d39173a13e10ca57ae6bfc18f5d8877f96adedbd257197d1555de110
MD5 1e26e88eda1f35ef05d950d6df755bbe
BLAKE2b-256 2bac15177f995f3e271a1e0647c736706f0508271f827732d0681742e197955c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.7-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 24d807f49cb3a36ba9ecf19c398beb697fc2f6fdede05d9e55fb4d0c81e88fd8
MD5 eca045a827bcca1bb19b08ce210615a5
BLAKE2b-256 ffb907b85ccc9f4858cce332090325d628bd03feb10eb0ce448e0d89175df392

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.7-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 17ff49ad2d22c1637e6ab3a77b91bff41854fb2f1e59d552588eb3bfdd65594b
MD5 ae2e3a1295f717ad00e18159d1f5fed0
BLAKE2b-256 c65c9f2c8bb542d40253e87cfe80eb8f193549be21acdeada52c9950752a9911

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.7-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 08384752ca26c096b27fe266dcc968534eac0ae526322af737d8871cc721f97a
MD5 a5c7af886de511331caf5ff7d3bee604
BLAKE2b-256 c874e4531a9d17983b0e1bc9386792f8814d49fec5220c40ba1d45f7c3638af6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.7-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 27.6 MB
  • Tags: Python 3, macOS 11.0+ universal2 (ARM64, x86-64)
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.20.7-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 25141e9b2e343a1dcaa86d23afab8d3309be08c408e86457643c4ad7e2f4875c
MD5 b21667870f6730c0547f4361d2348ab2
BLAKE2b-256 b0cd072105dd5cb0e2de7732e9374420ee78c37a370442c9513a47473c1cba35

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.7-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 13.1 MB
  • Tags: Python 3, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.20.7-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ee003ac1acbdcc3fdfe79c5c6c2dda58c3e45fee6763466dd6ec77c37abfb30e
MD5 911879b87019272b4917ca1b3ef717d1
BLAKE2b-256 073ac07871180ee17f84f07a6922fdb18e2bf997fe14c20f71c5addd82c70a05

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.7-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 14.4 MB
  • Tags: Python 3, macOS 10.15+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.20.7-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 17a6d3540409bd654aa075e5f3696420b38ef4d4137ab9ed5df61990f4034b4f
MD5 f6f5eb45b5c1c4b88782ca801e44b250
BLAKE2b-256 f4b3c41865fc73a58d9f02e574ab3144673023f2ba443a669ed167afc190ea75

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