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

Uploaded Source

Built Distributions

sentry_cli-2.36.2-py3-none-win_amd64.whl (8.6 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.36.2-py3-none-win32.whl (7.4 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.36.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (14.4 MB view details)

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

sentry_cli-2.36.2-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.36.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (10.5 MB view details)

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

sentry_cli-2.36.2-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.36.2-py3-none-macosx_11_0_universal2.whl (17.1 MB view details)

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

sentry_cli-2.36.2-py3-none-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.36.2-py3-none-macosx_10_15_x86_64.whl (9.1 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.36.2.tar.gz
  • Upload date:
  • Size: 201.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.36.2.tar.gz
Algorithm Hash digest
SHA256 e32e5ff5d831339f62c49d35bbf33ab42392fba17364e69aac5f6616c0276ebd
MD5 283b361209dcd2c65b4ac0e75ae0bba0
BLAKE2b-256 3e06bb1c33494d6cc816aae4d2ffc0d53b994fe1953c089a77962628d8413c6f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 f0ff858c3cc86ed2702587bfbd10271afbff6a19a9b5a9cfb7ab5e90b9819568
MD5 264605df10a5619647e57a715632715d
BLAKE2b-256 8b5a81b317a888a6262ca3ce90f37c9d39398784f99b49d9946fede9a8a6ddaa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.36.2-py3-none-win32.whl
  • Upload date:
  • Size: 7.4 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.36.2-py3-none-win32.whl
Algorithm Hash digest
SHA256 cee869ce0db4587333120c977a0c617fc767d6963c67c379a99d32f2be3da8e1
MD5 158b3c51f7c486c9c3ede7c2cce5c190
BLAKE2b-256 368e17bdec24eedbeeb38714bdd46a911761b28e18102034355c7be8da3db9ea

See more details on using hashes here.

File details

Details for the file sentry_cli-2.36.2-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.36.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 ace286f860e74a7feee9c280225d83eb14dd9f794bd86d59a4578264d7760a95
MD5 88069b4d03e9a9f0a769bc3028a8d6fc
BLAKE2b-256 864e7b98c9be08c3c4a8969740d7bbb39596dbe4ad4cf9e423660b31e8631390

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 f9e65d7da4e47bf2bd656492d6abd207cf60ccb58db3cb849271904dee4cfcdc
MD5 ca9f8239df8cf00493622dabb70cabff
BLAKE2b-256 6d0e54d310e10b06d861edbe3fe932a5e7ec2380a5502a2a0f9f88ecb74edc70

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 7b72cf8a2808b3908b99dcde204830518f69ed5574b9b9a466140038f83bb066
MD5 fd5eed527361409019d8d91cc9ddf809
BLAKE2b-256 36b4b5c2abbbfe9c3abbbfd39e0f95425485f41057aa662c40c2b12b8aebc50e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 0f44dbf6e9b98cdd49872a9d17467b42a1b7384fb9ab3a909a2d3309d2023faa
MD5 cb4b40e09fdac397a3cdae9802b4f55c
BLAKE2b-256 f075ccbd12ac6148a96d9a2ae28ca5a261487e401e6b4c0890d27316951463e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.2-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 00963e831779176ab8c00b80e35bf7487b0acd01da76869a51e0ba23c8946c94
MD5 92197f65b49f9576895241fb044605e8
BLAKE2b-256 fa0a9cca8309e4dac27ab436e231a5a73d02cf1e4254dc86be50f414bd12743a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 5e3deec2ba2966d4c7c8bcbc54ff6b3f2789384696d69aa16a03c50aef034e4e
MD5 1f2789e07797a07d9436dd387b290af5
BLAKE2b-256 667977db5dad37f07ea96cc536c133cf91539df7f1c66550482a18a3857a94c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.2-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 626684401df760eedebc0f7e837124b0a45594e432ee3e242961f83c7ca861f4
MD5 53c11c085c17ee6d5bb10fba359f4045
BLAKE2b-256 6075743730d3dbb559ac43b574477bd102782498a9adab0e641d6db5988677b8

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