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.

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

Uploaded Source

Built Distributions

sentry_cli-2.20.2-py3-none-win_amd64.whl (10.9 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.20.2-py3-none-win32.whl (9.8 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.20.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.2 MB view details)

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

sentry_cli-2.20.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (20.4 MB view details)

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

sentry_cli-2.20.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (19.6 MB view details)

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

sentry_cli-2.20.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.4 MB view details)

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

sentry_cli-2.20.2-py3-none-macosx_11_0_universal2.whl (27.4 MB view details)

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

sentry_cli-2.20.2-py3-none-macosx_11_0_arm64.whl (13.0 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.20.2-py3-none-macosx_10_15_x86_64.whl (14.3 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.20.2.tar.gz
  • Upload date:
  • Size: 181.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.20.2.tar.gz
Algorithm Hash digest
SHA256 9f95c4180704210fb8c23d282c4ad409d62b7f9e9604d7f06232caf32a00b539
MD5 02243a073af89d82620b825d116d6cbd
BLAKE2b-256 953427e778cbe19325fce8387c808f8a19ad4baf6f3e0f69e8217faeeb35df1f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.2-py3-none-win_amd64.whl
  • Upload date:
  • Size: 10.9 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.20.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 036f132ff53380bee93d7fba11ab622ff11e8caa690088426b3e1cb7b41b4b54
MD5 8cd5a2edfe0164c154c18eb59ddcbbec
BLAKE2b-256 1792262f8e498885f9d488c84895582d803794c79f3fded3da7b44a7af897a7f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.2-py3-none-win32.whl
  • Upload date:
  • Size: 9.8 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.20.2-py3-none-win32.whl
Algorithm Hash digest
SHA256 8e0256a6e6cd22ad3ea46745f83ea8550e5a7e84902f11ecf4d4046af2d78403
MD5 1c25baba0850c1ddf0ee713c890a552b
BLAKE2b-256 f3e8151ba1e04ff43b2c0ac4cd5ea53539ced659a9a0edc5e91b86b8c809588f

See more details on using hashes here.

File details

Details for the file sentry_cli-2.20.2-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.20.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 b8b0c9ed92ad0c097fa249bdef3e4d2bc799c8a4e236462ba8b4f92b7c170716
MD5 303b724dd163419604912f282c85506b
BLAKE2b-256 065f625fef803dc4b855c79b92a68bab53cfb3858d27336503b0c1652938b3cc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 a30ef4c76dd1cc2a93678e1cefec135fcd74ca883f887412ce232d6fc43e3cee
MD5 22a777fbeb537bf115c06852209edc0d
BLAKE2b-256 a94be305e8e92c46390ed2d9a41738e07ac7bcf22903f2f3f8450af2e6736387

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 91d6221ab47571f92bdcc68086186ddff743424371fbff431979022c5af3c5d5
MD5 8e0cc144d8208880fd83fc63e085130f
BLAKE2b-256 4d0902704db9b6c513b77fd1f2a1f1990be974372566bbe128d8e1ac2b65d326

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 131a80f07af275e54dfd1c65feb6e547f0f480baeaf36420f7ba89e5d9b5e211
MD5 68cb7bc219f92d8e4ca09762911159ea
BLAKE2b-256 62293420834967bbe3b2b67c89d10fdd7524a87cf9e3d0ae4dee07ec24571993

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.2-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 27.4 MB
  • Tags: Python 3, macOS 11.0+ universal2 (ARM64, x86-64)
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.20.2-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 72dbd7531b1ceede591fbd855a70e5b94d91e1f36032efd1ef14db45745915f6
MD5 ebe3e5c257d05ae2ffd2d0f2e3a5e4d1
BLAKE2b-256 a966be252891ffdf39770a60425624becb48c68d48b5952bfc22cfd025025f10

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.2-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 13.0 MB
  • Tags: Python 3, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.20.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 735fe10d8ddaa51c0f7affba9c403257ff6d11ea91db345c635f436446855c86
MD5 c08e695139aa0dc438abaf58f88a8fd4
BLAKE2b-256 293ca0f145faf37a623176d4595300acb387f05fb3455e7e6840a11028577ad3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.2-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 14.3 MB
  • Tags: Python 3, macOS 10.15+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2

File hashes

Hashes for sentry_cli-2.20.2-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 9759a60312c29ae6be965ace8a1b34db5ad4c6a30dafd4dd8fe9fb24245e724f
MD5 3753d3f2cf69118d3856d5e48148401b
BLAKE2b-256 dd20da9f0145ea611d4be497df0547f98f15754bfe336eff01cbcd3a65ac1c2d

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