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

Another option is to use the environment variable SENTRYCLI_CDNURL.

SENTRYCLI_CDNURL=https://mymirror.local/path npm install @sentry/cli

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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.20.0-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.0-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.0-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.0-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.0-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.0-py3-none-macosx_11_0_arm64.whl (13.0 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.20.0-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.0.tar.gz.

File metadata

  • Download URL: sentry_cli-2.20.0.tar.gz
  • Upload date:
  • Size: 181.3 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.0.tar.gz
Algorithm Hash digest
SHA256 259d3eca4797ee38fa775099cf38bea24b7de3e8b01733b58dc0ed135d203c19
MD5 b837ac9633d11b8d442106e00db3e11c
BLAKE2b-256 8db4d7848fd2fcd789980e5bfed76e1ef2c85cab040b9e93b1ea4f8e43811ce8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.0-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.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 bf750e8cfdedb893e26a04defb502c53461cac06a9ca32a8b618c9645071fda5
MD5 e23bf9679437513a61da2b6bd3109928
BLAKE2b-256 e6ecc25caac7aa04fec196c3a3773c8d3add5e5be4e5154df774b230b53851d8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.0-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.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 a7553ecb072a71257b100025d4564a07a05f4e9f641f2e96213261192fe6373f
MD5 2d87f0955e58c2e45f0b572dec003c9f
BLAKE2b-256 ab5d17f0cdfb8c95d1bc9bcc6cbfaf4219459554ddd11ece51b64c2514099d54

See more details on using hashes here.

File details

Details for the file sentry_cli-2.20.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.20.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 9b82965b11366b395bba22239fbcbb5b8b802984320f46cc687e83b8f976e73e
MD5 5d22a072be4ad1408423760608369f1b
BLAKE2b-256 d673b46371d91d30441accf2d55b64bffde7d3329b6b6b2e8d3d7585d122d4ff

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 8310bc78c37f01e6cec7d9608462dc7e9f1729398a8bde973b343ec7695ff925
MD5 ac2bbe61593313009de86d9f27e61026
BLAKE2b-256 2bfce36ac6f372f5689e0bfeb46ea633d35856c383b6661bfbc02dcc451253d5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 3360e889cb0f36d2d4dfd5bb8ab9769727fe53aa26168d5061921ef6c3f37d1d
MD5 3c98920b52157db0e2cff2af34fc17a7
BLAKE2b-256 ee8997425bd3361dcc702455a248fa0f96b852b3cf056e001bea49c8959eb89c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.20.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 897a6e1f19f41806c48f3671587126aca5d3a35e940565b93c0d697e35418b34
MD5 6b0ff99d39e3a6127146ef459237ead4
BLAKE2b-256 00430891559a0e312ba6e1f8ee6b9860a2a53bc63906f18bf5b83ac5fdc71c89

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.0-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.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 c5791f58460584431b098c26412bca2b3bfac252b91ccdeb2de1ef5269887cfe
MD5 10a08524c295e28fa06f2804138aa670
BLAKE2b-256 e28d815fa42732a3deb4456b0069dd20ad01c6090d22198e5b8b9660c48f318b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.0-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.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0bc736f5d282f133cff5fd2b96c180ddfd30db82ac999ae086c333844062816e
MD5 9c625d98647bae247962079f36d1b03a
BLAKE2b-256 10ed64cbf7b6fec925d97b9298e0a49f55f36a7ad69bf4b0c445c430e64107e2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.20.0-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.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 4fb1189178f50453a59508e742b975e99f5d507fd00d11e01efaa4e7d14b1f9a
MD5 b051f0d053495c70157277e75f825365
BLAKE2b-256 3eaf2e60c925216335b5c6f17c786c54392bbd1e0754f8a5cdfe860d76f0cf36

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