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

Uploaded Source

Built Distributions

sentry_cli-2.20.3-py3-none-win_amd64.whl (10.9 MB view details)

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.20.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.2 MB view details)

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

sentry_cli-2.20.3-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (20.4 MB view details)

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

sentry_cli-2.20.3-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (19.6 MB view details)

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

sentry_cli-2.20.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.4 MB view details)

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

sentry_cli-2.20.3-py3-none-macosx_11_0_universal2.whl (27.4 MB view details)

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

sentry_cli-2.20.3-py3-none-macosx_11_0_arm64.whl (13.0 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.20.3-py3-none-macosx_10_15_x86_64.whl (14.3 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.20.3.tar.gz
  • Upload date:
  • Size: 181.6 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.3.tar.gz
Algorithm Hash digest
SHA256 23300b3d6051b8caf6c584b2e121bfd64a2505a1caca1756e06737950d914fde
MD5 acc6872708a3f654a3586a5a7f08b30d
BLAKE2b-256 1193664c79a96a64dfca25d072c47c6bfc5f3f5367710011854683a206b902c2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.3-py3-none-win_amd64.whl
  • Upload date:
  • Size: 10.9 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.3-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 8c160cac1694da2a79bf76c8b0fc09ce2118b0ea79dea8b46fe49f0d5a41fa6d
MD5 8b8c324e90064d9c35e88eed94f4117c
BLAKE2b-256 0309cc5ecd040fe244e93476561c3a400880d784fb6a6f8dba088e8b63939f7c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.3-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.3-py3-none-win32.whl
Algorithm Hash digest
SHA256 d2f238acd9ca3f94672d72b61de889d230fa25102d4bd4e7a3b23cd3a35683f6
MD5 36c2a7489965f08a65ed5ceb7e0770f0
BLAKE2b-256 9780fd24cca588f4d454c0f43247f0c376880e859e507d63282232a869932137

See more details on using hashes here.

File details

Details for the file sentry_cli-2.20.3-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.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 1f03f7b56ee6b881f1473315f20f50faf8447fea5a8c9502750641f0355a9a1f
MD5 f5b4e803b98f9b02c3a50a329ea5013f
BLAKE2b-256 af9ea4386ef6d409cea07a833756e153596a41dc224a7d508a455672eaa55d75

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.3-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 e35e15f5622ff28e83af1d9a0c9a61669aceb522999d275da86b41b519192826
MD5 82b5ce0bb43d58ba903f829794f69ffd
BLAKE2b-256 172f35f64b301c1f7d0696a77ca9fc269289a923d6f44650d233afa0d01f0e03

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.3-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 cd67d3746e4d65a393ac040be76352c74f22f15c9e24d7f732b65132069de787
MD5 337d67d7d6a939542114ab4bf035c7d3
BLAKE2b-256 e08bacab676a5f0eac751ab2504ab7fdf5ec2b2fa90811a7d36c8c07effff23b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 b67a6a97c60c3286b91a7d427bb30ceb0d7e19d66d94b8114ffcb4fa262a2c22
MD5 d618320ac7143de3e566a9172f224204
BLAKE2b-256 873a3ef86beac54ab4cac89d290e02fb3e77e24f37b13e0563625af1c2b54997

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.3-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 27.4 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.3-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 204efd52b2fb517b7689e3d7f6f06e05e2be25a8a9de2a84a4190ce484f215a8
MD5 87f5bcdeb2bf09efd0576e6f616dbed0
BLAKE2b-256 35dab99cc39a86ec138ab21f0da8555c197e5c7e82d8d4c6f97172eff900d557

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.3-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 13.0 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.3-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b81c58db5135d6d81abb9e309999ff3fc070074679fe852d4050fc0075796186
MD5 241ca635547c826e3b4c101d75c9ba78
BLAKE2b-256 65b922f4c4628063c69c72c5e1d6cc5a338ab26327dc262120f38a8c2423b3e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.3-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 14.3 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.3-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 871bd22106e0121ef2eee9cfae286e8eaa51e36bb6cf0891c6ea77cf6f4c7482
MD5 3cc6e73106aaf702ea771744465ea3c9
BLAKE2b-256 3084c0065e195781bb3fb62ab125387f3669b02fbc6195d669054f1839424952

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