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


Release history Release notifications | RSS feed

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

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

sentry_cli-2.40.0-py3-none-win_amd64.whl (11.5 MB view details)

Uploaded Python 3Windows x86-64

sentry_cli-2.40.0-py3-none-win32.whl (10.2 MB view details)

Uploaded Python 3Windows x86

sentry_cli-2.40.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (19.6 MB view details)

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

sentry_cli-2.40.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (17.2 MB view details)

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

sentry_cli-2.40.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (16.1 MB view details)

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

sentry_cli-2.40.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (17.6 MB view details)

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

sentry_cli-2.40.0-py3-none-macosx_11_0_universal2.whl (24.7 MB view details)

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

sentry_cli-2.40.0-py3-none-macosx_11_0_arm64.whl (11.8 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

sentry_cli-2.40.0-py3-none-macosx_10_15_x86_64.whl (12.9 MB view details)

Uploaded Python 3macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.40.0.tar.gz
  • Upload date:
  • Size: 204.3 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.40.0.tar.gz
Algorithm Hash digest
SHA256 516f5514215bfd6303488f3123885ba0367d5460e393d5bf19d97a607fae0dc3
MD5 3ea29ce1988a8b097a609a64c3c80259
BLAKE2b-256 a24cf31d368974c97180b7c67b5eb7c644c7b8a006510933f9ec2c58d70c76e1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.40.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 11.5 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.2

File hashes

Hashes for sentry_cli-2.40.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 d23c7bc77067da7262675b632fb9d1c0461d8672752b4d2c01db689d11cedf09
MD5 925429d0deffb28bba76ffd299ccbef0
BLAKE2b-256 d9cd551b39eb202d61d804b8e754871f53969c48ee4130b3e73234ac426d3217

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.40.0-py3-none-win32.whl
  • Upload date:
  • Size: 10.2 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.40.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 6db557187522fb44f1993a1069116a367173c22e83b694cef10b244bff9f6b4d
MD5 4929af8456b9e50bdc0dad26f1cbc2c2
BLAKE2b-256 caf4757f6a8d0352aa7c84f1f0587cb6dc2ff2c9d71eed3756ad48a4b5dfa60a

See more details on using hashes here.

File details

Details for the file sentry_cli-2.40.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.40.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 5a4eba02221b5290fef296645d68f7d6002f99f953a6147de3c13e96b18b109e
MD5 e912a46257f42522dd4ee201c62d96a6
BLAKE2b-256 4ce41d3bae3a17bccb72028675c68472da3d9519bbf8b69128ab19d09f58cf2c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.40.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 592afe015c25cb1a583e0a32114fcc967833f42ab4ffebc5fa042f1f8819fa2b
MD5 9982de92f417c4f0fa17520f7bde6783
BLAKE2b-256 7478ee7ff83919208eb53ec69545c56161a428d685f97a8409e503985a986563

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.40.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 e29a1ecb01dc74d5b4454afde6b3443057035e899d09b4f57252acdd8294cb25
MD5 fadee9d15a391cc405a2297f14437441
BLAKE2b-256 86441b6913977ea83d18f55c60ea2b9f631cb32014e4b3c1a73b04298a519d46

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.40.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 6fdc5359da26e9c14100e53799208e65f2f19235c777a658ce94ef977296cc36
MD5 77f3092180a84bd68f36e66557537e77
BLAKE2b-256 6b6d8c3a8488ba67aef46960ae2b2474146005a8c45f484de19640ed31d323dc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.40.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 f84afa0994183c534b8c157ec52a1307db568c8d307ccf2a7257d7a77b8b6b65
MD5 c11599391a83ef119283f6a831b2fc41
BLAKE2b-256 34b0613de41d44e16055a19d0b06a030258017b22edf4b8305bbc60591997728

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.40.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d7e0cf23986de78d7309d7c523ec4f47f90abca2da52ad781883a502660ebd37
MD5 c913f7df97f85da8168a99e3b0ec1a18
BLAKE2b-256 df745249be8149564eb5716ff249aeed260d9dcad2c3c484d9d903e0ccce64c8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.40.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 85a9feaa3a5537e203f410be82b8e60a564d628636bd79039bf16d2483ba7a8b
MD5 84d60e666cf66f6c7ee4c12dc8b0f8b8
BLAKE2b-256 dff31afd046c0ca182ecb4f3e12b1b9459ade291ba6033a6a810c77248951904

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page