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

Uploaded Source

Built Distributions

sentry_cli-2.19.1-py3-none-win_amd64.whl (10.7 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.19.1-py3-none-win32.whl (9.6 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.19.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.1 MB view details)

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

sentry_cli-2.19.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (20.3 MB view details)

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

sentry_cli-2.19.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (19.5 MB view details)

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

sentry_cli-2.19.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.3 MB view details)

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

sentry_cli-2.19.1-py3-none-macosx_11_0_universal2.whl (26.9 MB view details)

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

sentry_cli-2.19.1-py3-none-macosx_11_0_arm64.whl (12.8 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.19.1-py3-none-macosx_10_15_x86_64.whl (14.0 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.19.1.tar.gz
  • Upload date:
  • Size: 177.2 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.19.1.tar.gz
Algorithm Hash digest
SHA256 0224a4bebc3c082fe705c5d8ad4e977555a04fc4c15112f81389237db64ee7b8
MD5 f04623532561f7c9d573ace5f315b290
BLAKE2b-256 a05c13535e0c4cd1201cd6e02850a4a437cff78f25a3c94ed2739e4bfeb23d81

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 10.7 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.19.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 5706fdbffae8eafc1b79581bd0c1407671d16e58fae87143ed8b8cc9f1e7eb18
MD5 99bc7cf87b57cb9a82a96a59fc0812d6
BLAKE2b-256 fd9b6aec076f1c68c1fc5c78348383ffa97b68570b9bdf5512d5cc6c7b9c5758

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.1-py3-none-win32.whl
  • Upload date:
  • Size: 9.6 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.19.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 80f75437fc601d0a3c6eb096ac87e40a95c0e1bacd1fceba14590127702f0327
MD5 ae3f0a67fe8ee1c16fa75ad46cd31657
BLAKE2b-256 39fcc800b1c0db70f4466f37d6980c2505df5ec340866e4cd6229e95fb94967d

See more details on using hashes here.

File details

Details for the file sentry_cli-2.19.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.19.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 74dfaeb1853b212484f13ca710c1eb90f9cedba604846e292b3daa3e66ade456
MD5 58a6e14ca274ab7bb60c2474b10ddff8
BLAKE2b-256 de4efbe2a3852cbce84fc65d9462c5f85fd80fc594e1de03782c29af153c693b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 cc46aacf20807520e0dde2d8e9f14d1443dfa6c2fc178d95021a3e0d4c9972e6
MD5 ad2a732498434a39a312c45e1bf5661f
BLAKE2b-256 8c21e1155caa320bd7a4dc6b6b08ba59c6e680b91691b70e4db24069ef325a45

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 1ddb3b6c95d2b8e3b8b65d2b9070a87ccf78c31292f73ac0d98935d8f3da73f2
MD5 ade1770a7f3db0c26465c9bb1ef04837
BLAKE2b-256 42033929feddfbc46c9d24efc788512ebaf9535f7d303daa5e8ee1ef147ea39e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 98632dc0b9e40ac4a4e1c552df8e7c65fb313c8df13ee83d476c260e5b7c12db
MD5 ffc5a42a10f475af5ffaf81f237845a5
BLAKE2b-256 6d4f5e0e89c89b9652b0738430bfe5e40920dbbee1736ee0cb9f05064fcb4b04

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.1-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 26.9 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.19.1-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 426334efe29241d563bc9b324885e5ffd0620e7cf48fb122b65311b773c749e0
MD5 cc60df8f47eeb9726c3ab6b7866cb56d
BLAKE2b-256 9bad3b714be6cb53fa25bad244740959fa07085048a09de6541a166526f6485f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.1-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 12.8 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.19.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9257d9c0a31ecf44c8afcd14979e7717141711cbe325eebec75e2b392af357e5
MD5 4e50665f0d601d7d628504e2b38ab616
BLAKE2b-256 8d6ac0c967595ec190590691e4a46a46288e154c9c934573bd16685bb81a857b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.1-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 14.0 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.19.1-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 0986d564fef3542a1b9c402fc46bee9c7d7219c52a7a695c0be1723a2a01467a
MD5 135560813cab63c7346d6c91c2ec6ff0
BLAKE2b-256 426fec5c22fe4b200baa3a1c01e5d8c023c888d7eec5dacda4e02c61179c3d1a

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