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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

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

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.34.0-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.0.tar.gz.

File metadata

  • Download URL: sentry_cli-2.34.0.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.0.tar.gz
Algorithm Hash digest
SHA256 8fef9300a3d6ac34f6e82e9df6706e8c547556c72641dc932eafd2ff83d43b08
MD5 c72c2959a26fa70e2e87c40de7a3b850
BLAKE2b-256 086ab8add4f86adc588fd8441570791a1f685435c57f386eea45f9c98bbdf437

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 0f1951ee0a0fb01f967e682cff57c5044437c20ded089b2a2f2707487ae26eb3
MD5 0cade386557d0bfe7a57a8f787973b3e
BLAKE2b-256 62572c554f02e34077a94c5c8af51dd32e7e84b10899a39e6b0f9830c51498f4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.34.0-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.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 1c408565017de0ac5e95b03c47e5d29301ef634e352abfcad5e81d92b61b9536
MD5 72c8e36f0614a005baa21e5a815a184c
BLAKE2b-256 5093a86da9a5631572c715d5be102e45465fe7eab4f1d7da400342afe73e04f0

See more details on using hashes here.

File details

Details for the file sentry_cli-2.34.0-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.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 d8270c1a891fc3273f8f2d1f457b08c308eba8a97aedc9decb35b60c4cd004e5
MD5 0e596f957c089627a95fbf1e4de017db
BLAKE2b-256 210a68f24f47c3f602fa202b61d46c7a5c40a70dd043c2192150f0390bfdc1b6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 0158541124aea8ea6b7126c76fb754e6e4ed6e4f210b07f6abe70accdb76b41a
MD5 fd16540c6404037e06059ce19a4463c9
BLAKE2b-256 2e85f0496c105c9cb2598d4f9eddf17560c0a86a5077494a24be0342fc2bcafd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 bb2f7aca9dfc212118465534808c2a1376cbc5e2ec5e5273c60400fe55bcc5e8
MD5 59644b2b59cda5e00b73218ab80e18bd
BLAKE2b-256 87571919314d7188aaa6e0cf55fa9592232707822e9a8761af14651d0bf1ef59

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 f3d3ea2fde16c65ef3c61f76e3b62345ee03e444adc9d1a18bb799971ca7420c
MD5 c403c835fde32550ab7073b1981b6dd8
BLAKE2b-256 2d94e191f513c92e380a2e29bce765637104ba7663a7a0600a079b7a425cf31e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 1ab9c44d28b0e8bc7706bba8b4a77738ddc5a8cc5889d7107a092fa4796fca21
MD5 973ddf40ac000ff3e780a936b41ded9d
BLAKE2b-256 1599b691ce482ed67245c6b1f384f95079edf0dc28b623a16e28e7594a2dbb95

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e4134cdec3e6c7ef70d09425ddd08c3542dbfe27cf309a3b7f575f848b78756f
MD5 1bfac00109c619eb3dd84738581ecd45
BLAKE2b-256 5a9360d0164a381d8d0710196487aadc52e09d5c73fa203be453257dd2f8b52b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.34.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 4706daeffd495d3cc63b6f6d202a9d183739d37f9f72d94b0a489c9401b3dad2
MD5 c42a1f2e5e90679aff788165c2dc639e
BLAKE2b-256 fc0db82a25130e5ee3b347ae6bb08e50dbded8e7140212e616fd6ffe424807e7

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