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.

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

Uploaded Source

Built Distributions

sentry_cli-2.32.1-py3-none-win_amd64.whl (7.7 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.32.1-py3-none-win32.whl (6.7 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.32.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (11.3 MB view details)

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

sentry_cli-2.32.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (9.9 MB view details)

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

sentry_cli-2.32.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (8.9 MB view details)

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

sentry_cli-2.32.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (8.9 MB view details)

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

sentry_cli-2.32.1-py3-none-macosx_11_0_universal2.whl (16.0 MB view details)

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

sentry_cli-2.32.1-py3-none-macosx_11_0_arm64.whl (7.6 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.32.1-py3-none-macosx_10_15_x86_64.whl (8.4 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.32.1.tar.gz
  • Upload date:
  • Size: 198.4 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.32.1.tar.gz
Algorithm Hash digest
SHA256 d7fe22202c0dd7883c14a3c95e3dfb8c901c68c1ba0d2339b17b197112a7ca46
MD5 e2f20950933b4668ca94691f8de3b299
BLAKE2b-256 f753553eeb0a8181a97444c7d92fbcf228eac24f7a9f1590f4f84ca9e3139e59

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 24f0297640e64d09d8609a86b32de9cf49fe51dc3e32946018cc0fc3cc5b4e06
MD5 67766f11d54a9d080afaf2aae7a2d735
BLAKE2b-256 f9a9c9136e2ede3812ecef9b34a679d1c70ecd5598ef7246cfc0ae5c20baeaf7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.32.1-py3-none-win32.whl
  • Upload date:
  • Size: 6.7 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.32.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 a24b463c128ec900fbdf9792c587c0441e4dbf61cea3b1be9052f996bfd4d234
MD5 8d0583822a75203aab5829b49124d064
BLAKE2b-256 31878e2418f9b68e0984f3fd9adf279ce857e7f5ca76ca37d09af903361f5ee3

See more details on using hashes here.

File details

Details for the file sentry_cli-2.32.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.32.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 d449a13983041a4830576b3fbb8039f5895352cee21df8436a640ba8c6aa20e8
MD5 3dffc132753b694c6703e2166b0faa41
BLAKE2b-256 a1da91bb2294f1bc6f8d12c27a448bd9f050c9744c7e1e2b8c3fb7919562665a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 8175de8e32346a704a86a4ba8298d634e6bce03c289c110154e34d120b63cb88
MD5 9a3725231b968522bbaeffaf30c7417f
BLAKE2b-256 ebd006265fdad84bbf12bd2711583d928da08481cb6b966f39a3c3709103e527

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 eda365f8641561125310ad7f0091ca95b77ef06224198306b17020d7a830d72c
MD5 ae32fe1fd565aea9e6837fdf62486390
BLAKE2b-256 2e210d74f57913998ef601dc458fae311a9e42a65843d37b81d7fc185c673628

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 bc76b471138995dd9e204e747125ac2e2b22b5c87563fb991623444a06b838eb
MD5 5c376dbbe0d955336001622e58615397
BLAKE2b-256 fdb0bc717c0b705e8470141d2c57f10bef950770de42f62912a0d7af1a696a59

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.1-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 79bb5559f24acd10b9aef4670856cf9fcc3e73effdd97aaa0f4f3181f58d90ee
MD5 52a34790f873490acbb27a36945af861
BLAKE2b-256 d785ee7333ccf8461249fb312ce27d4c645044891d2ee227a37f4d41425c84d2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e305bb807dc7c0f595ac99da05e60fe70f3903fd24b1f33c9bd574174ef8014f
MD5 1d22e436e0cf2b971487afe93350f967
BLAKE2b-256 489b1ac732f103609b7c42b26ca816511a510226887e2b99df513d6a6ccd4604

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.32.1-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 31ce16aa5b643528c780b495865432e321c5e20080b9beb02ca7baa1addff860
MD5 1b0801e0fdfddbe1aaeb8a1ecfe13d02
BLAKE2b-256 bafe57307a0fba6b57e910164557d10fbd43855ff75f60e0a7c5aa0538980852

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