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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.36.1-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.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.36.1-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.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.36.1-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.1-py3-none-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.36.1-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.1.tar.gz.

File metadata

  • Download URL: sentry_cli-2.36.1.tar.gz
  • Upload date:
  • Size: 201.0 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.1.tar.gz
Algorithm Hash digest
SHA256 4be350656256a7685d1f179b6595d2515d551836f21a110839dbd346df618448
MD5 06f8656a308d1917d6c134bea1712ee2
BLAKE2b-256 b8cd5ebd958247b5ed942aa825d820538fde7ef6f70f06acb6f1a1080f8cbae0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 d5056d3c637e857268aa8124077dfa15f33994dd3adfe0771677cc8b126c2cd4
MD5 9576dbae531f38c4a088e9f1ce2e1708
BLAKE2b-256 f9bbcdd9e7d60062598e919e293b84cf247d7370d5ddc193f9cab5f29863004a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.36.1-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.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 f65c50dab359e44354b6347530e531a17bb82415923968d81a4f8160942aa818
MD5 d3b6416a3710aab2b55654d8c5d20576
BLAKE2b-256 30ec3eed48feb548deadd49d6a32ff918afadcc3ba5c95af76ec3243aff72285

See more details on using hashes here.

File details

Details for the file sentry_cli-2.36.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.36.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 1ab981b0bf03935e2847deb40273e1e7b21d2c13022f15d91cb0ec988add7f31
MD5 54c49cc7f569bae75630fe64676a35f9
BLAKE2b-256 74560da57dc84c26c102a744485c11e93cd3b78841364b7bc1268524f7621420

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 0543cfad47aeb2d1d5b55552c2bd94ece455aa8879d9f0c4d8e601959f21cfe6
MD5 5595d7058ced783e227e3356dd0573aa
BLAKE2b-256 9de6f9cb9601252e5619bad6cc5ec0414388bda5647c0fe8c20710ff7400ec35

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 9d39bea4699a526e16a9424bd78c54a8e7285ad14311471ba248dff6bdefe4c6
MD5 145e7bc051ec63424d7216ea3220f757
BLAKE2b-256 5fbae168e068987df25430aa08f4150ac5048537c7ff54dbbf65c78439919e0f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 aa4407f257e93181009f5cd1ea4e9c2cedf57be73cd66669ccbad449a8b371d9
MD5 2c56ab6d75b10c0e21056f5d63d9b891
BLAKE2b-256 7b892a4340dcb61858927eb212b9a147151df312a908457e898c79218e7ed413

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.1-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 ddd7be9235c14d72d9aa2df5a17eab238e85fe1dc6ee10683eaf501ec7412922
MD5 f600e3eb24f08bd7b4d19cb0aab7cdcf
BLAKE2b-256 c5a9ed9d4f82f031c3e7507e40c297917eb90fd11decf82df2a1c58acca87e73

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f475bc5fa79d266db3ffd33a69ca7bef9949976aef708dbafa81c35cceb3c8e9
MD5 a1752f8751b83562c731e7255bc64e90
BLAKE2b-256 989c15bffc4bd6c1a296d8397cc04f6d42836ecb0b36fd7a94bf1bf7f37046e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.1-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 f8084e3203bd1afa54b1ddfd36a0516eb9a04a5a3de17fd78ec6f93767b44629
MD5 e67cbc8bc712a3d39555c517013bdf81
BLAKE2b-256 226d800042445f71b910684771b775762025441a526834627f1ec678396cbb6d

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