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

Uploaded Source

Built Distributions

sentry_cli-2.39.0-py3-none-win_amd64.whl (8.8 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.39.0-py3-none-win32.whl (7.5 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.39.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.39.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (12.2 MB view details)

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

sentry_cli-2.39.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.39.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.39.0-py3-none-macosx_11_0_universal2.whl (16.8 MB view details)

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

sentry_cli-2.39.0-py3-none-macosx_11_0_arm64.whl (7.9 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.39.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.39.0.tar.gz.

File metadata

  • Download URL: sentry_cli-2.39.0.tar.gz
  • Upload date:
  • Size: 201.9 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.39.0.tar.gz
Algorithm Hash digest
SHA256 9e043ced0803e5b5c99f14846b61ea7bf85389e540d9971d36b4a5116e08c69a
MD5 22c73b8101de979dc964b46db0968639
BLAKE2b-256 f6dcf92297822a99dd486b9ffef40e5ce9d9807d837d9933d1dc776dcae83c64

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.39.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 6c67b65632f1f346fc335ac77b3312c6c7a87715b45263a5c2b7c192604ab947
MD5 4927a52123162057509e5493cfbe9970
BLAKE2b-256 7fc707c76ba1406276f1f7d558a3d04d30a151322a52b48c5074d309c0c1bd8f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.39.0-py3-none-win32.whl
  • Upload date:
  • Size: 7.5 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.39.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 31b9d61ca9dcb19694ee4f7c25e458f578078bb86b5a1620b12ab80aed8e4491
MD5 046feffe7e6300efda334f4b6dc78da5
BLAKE2b-256 a1129709dea4806ebebf568c54803bfe9641fc40c73f81dd994f07044d3302cb

See more details on using hashes here.

File details

Details for the file sentry_cli-2.39.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.39.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 cd086b942e11ad1f358bfb52242f7ab80ff1b504966861372054a0b4195c2b8e
MD5 581be05c2aa556ec7877e2401f0e8b91
BLAKE2b-256 4d44d5dfe0fc95c89dd1239ba4d1e536a8768ff29fde777802179b1414157152

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.39.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 ac367a7a0995ad987e09c6419698c5813b912d0abdc1152dfbab8e7c9dff4928
MD5 ed66b4e7da394c30fe86c0ad2b1f8f94
BLAKE2b-256 d4dcd97f98605655e7d204f48d843e8b599bfa13fc7cb60a1fdbd413ccdb0746

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.39.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 0e551ae6bbd6303352017c8be1f0d521be5c29f1d3e58fa7f0bc3983f4370f13
MD5 e39466c7c5fbaba6ff383d82b12ae907
BLAKE2b-256 5f8b175555be1fd55dbfce96e6e0dcea18b75c71bfaf4c907e3560986593d9f0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.39.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 c814e7f84a5e05126ce38c9e8c53d95179079ee8b4c4413117af38968c3b820b
MD5 7e00e6fab017a019e77776f56bd21214
BLAKE2b-256 f2123fae089c1f88c875ccbfb37d07af7c0c402676cbe3ced27b5d3ebb4a285e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.39.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 af6b8cc9e8e4b8435e9d644c6783dfb35b8088c9f5f8fff3bb07212cb26e3d86
MD5 98ee2bfbd21836ec60f62084020c6b04
BLAKE2b-256 a03908bef48e2a1f4d1cb79b46c84fa52c63c181d20f75e1862687e8ad322d42

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.39.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 09d2352ed09d2440033a1584a4ec6843f12587d9e4fcba05a096e4f5bfea983b
MD5 c1a29f16a8cecc625990800b84d17b27
BLAKE2b-256 d142bdedf60cc8632f98468571e85dce7026775c65c878477330e7e2833721ca

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.39.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 008c1b3b3dc3d435a52a4596856bce8333e1585a00cbd6a770666aa5b87a3795
MD5 3f943872ba47d6ce1b64301a79d19daf
BLAKE2b-256 69c34f5f64937c54c3e3fe49ccbbf90e8569418b55d3cd6e3ae17688a41d664d

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