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.33.1 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.34.1.tar.gz (200.6 kB view details)

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.34.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (14.5 MB view details)

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

sentry_cli-2.34.1-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.34.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (10.6 MB view details)

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

sentry_cli-2.34.1-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.34.1-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.34.1-py3-none-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.34.1-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.34.1.tar.gz.

File metadata

  • Download URL: sentry_cli-2.34.1.tar.gz
  • Upload date:
  • Size: 200.6 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.34.1.tar.gz
Algorithm Hash digest
SHA256 1f13c1df15ea927b77612b32ce95ae3ff9c5bce246fc88b957f02bd555586fd1
MD5 cfc92836778c2be052bbf0b843afc445
BLAKE2b-256 ef85b0cd3587266dc1579fa3122157c50a68da784ef802e781190e861d610516

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 6b46bbacc87583227b4a87de4e5e673a459c026c6c81a0df6ad530e71d1fc4a7
MD5 3d29d5bf05893e3969693f366d212e8f
BLAKE2b-256 db4fff4c083d762db655bcd8a0a942de2097bcedc502c3c582370ddef6079f8a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.34.1-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.34.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 dd387d7ba8406f64d76fb269838dde90a20fe50a1ef25de32a419f2037d01a0a
MD5 445571c9ca40fb8b4495742d37ff3c48
BLAKE2b-256 89eaca85d49a7e5faacd5dda3b115c0d4d5c4e4dd6ef4063ee3b8ce2851af796

See more details on using hashes here.

File details

Details for the file sentry_cli-2.34.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.34.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 2f587ce77b9de64ff5c5b63839a1efa32bab03d17326461757b355778203e776
MD5 4b48cc7c0a606fd02c811b1f18ec0d56
BLAKE2b-256 2f64e5c99ff693f6778561ee2fdd24dec48f40bc9e052cba1ba8c15a2c2a03dc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 d21680570cbc509eb5a723354e397d472ac101c90f01fe10ea8caa1401755b49
MD5 1ef80d8ff33edb18cec7de3af4fa10cd
BLAKE2b-256 155a10a9c53f2092a3e1d6b160de479a7e67c6ff9cb9eac2935ac0bd08eb52c4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 8304d558aa25021fcfb82ba4f1330f2ccf5fd558e4074309d1186dcdbfa98f29
MD5 6bba5ce8161739df3f427db2e36a7e05
BLAKE2b-256 d82d928199de9db1066145e4ebce55f87dc08c59939c37aae789ba50b132f3f3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 ed720df2e80c296260d2e5cc383e76c9c72bd2078aaaf36fcef7a8db5cef3eaf
MD5 d91e6d1571329abfe11490deeabc237e
BLAKE2b-256 95462f6b382b462e5a93acb163ff73ee6cd3d6fe767505a6353b9994424e83c1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.1-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 a7dfeb2f3dff5f816a553280b9ae34295f362816b6c7a02e87b6d4e4b2ba5465
MD5 86d35d7d47475fd50d88db1cf4a1df04
BLAKE2b-256 0e3832aa09b2092ff62a782ea10760232397709480387bc583b11ffcbb5010bd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 73dc220600bb7bac8404d7c2564777725951b3b3290ef607f72ab121ff38f545
MD5 c1736380337e9c749b7289a3d768b4a4
BLAKE2b-256 d0a00d940233a75cb123b12780d2275638ec2e03360d9513d8baaeede6eff1da

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.1-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 5d771653052cb8322f99d39e14ededde813fab6bb472a93d4658e2c6e80710d6
MD5 33d227254c7ac59ed5e0a960814c5e94
BLAKE2b-256 9ac7377983a5348ff9827524fc0174dd0a1317823c3483a6fbda4ec5ea06086d

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