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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.17.2-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.17.2-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.17.2-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.17.2-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.17.2-py3-none-macosx_11_0_universal2.whl (26.8 MB view details)

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

sentry_cli-2.17.2-py3-none-macosx_11_0_arm64.whl (12.7 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.17.2-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.17.2.tar.gz.

File metadata

  • Download URL: sentry_cli-2.17.2.tar.gz
  • Upload date:
  • Size: 173.4 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.17.2.tar.gz
Algorithm Hash digest
SHA256 e6c4a3350a298a80b4de85a6d0d029881657a2eb0e6d25d7b0ef0abf0774e025
MD5 d7fc462eb4b38618272426cf81b3e0c3
BLAKE2b-256 71a7724320e51777bcf680d8d1adc3d93946a6560ac2f3b274590b49c7217dbb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.2-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.17.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 83190ed5f78144167d88363cc628c5b32bc073bb7585acb8787e4cebd90c74cf
MD5 f87099698fbe99e0f79d3c081d059508
BLAKE2b-256 165522b339a225a6d956607ad8d38713d9c736fcb38bb2910641ccaeff779fe8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.2-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.17.2-py3-none-win32.whl
Algorithm Hash digest
SHA256 9ca0f42d16ab9e740b2699bb65744bfd6716415ed2702202830e34a5138ce13d
MD5 06805dc47467946ec3aa3cc8f2a19aa4
BLAKE2b-256 76f1f7102f05c5e193319dacae475b4b53fef2c46b185bd2d8e5d05f5dbf8eab

See more details on using hashes here.

File details

Details for the file sentry_cli-2.17.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.17.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 e82fee24167d28834b5fb7917f5019ab51bc0314c91c08c17ebb7029d6cbfb4f
MD5 1594287abbd869f35102149aadc133d2
BLAKE2b-256 d5497ef192836b8838fd70f9975fec328c5b200caf60df13088785c1600ac646

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 e022f724df324cd124e23c41f4fbb8a7ef32cc676e92704c5ab8ef1b15916869
MD5 5e36e19e50490a5e586785c6e2d17e62
BLAKE2b-256 4f02ab1d129f81fd4e02e4dfd11b53e15e3c72f284ec8ede0e5a9a0ef5a1204f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 c70da5ebc9963d90e3cde88818d581e3d26291e174b86bdfb165d6bb1cf8ee84
MD5 23f35a6050d2a1a7cf9312700633ae9e
BLAKE2b-256 22d7d95d0909ca000e2f88a461a2a591c911e6015781cca8751dc72f61fdfa2e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 5262eaf49e4421098d1dfed1f7556ca0cb8cb4ea7ca458a5a7617d8ba56b8bbb
MD5 b25cb947e0cda6015243bc85f82dfbbe
BLAKE2b-256 72c719e056be24c70611abea22405fa84e959bf2c5348d26ae9eec92012821cf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.2-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 26.8 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.17.2-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 fb35e11d95229cd13f73878f9ba4662e6f1e7fc54b8c8697f1da6203d9a12933
MD5 179598f306755eefa0d8f775a7662c0a
BLAKE2b-256 654677eb87243507f3877c30d88507c23ec5ea619039375e6f112f56cb5c7a4a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.2-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 12.7 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.17.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ba50efd5e31c5a1118cf2806fd80c16e6dc1c37c3f5f3e12c6a8a256fc15b4ec
MD5 1d4f75e2f54eb6a7409f5065f28402f4
BLAKE2b-256 9f4a44008c7d237c4f653ca5a4fa5d47154de88c6c4a830b23c365d42a549ab1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.2-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.17.2-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 769f7f1ce1bbb2262841684493e7c2d671a838128c7214ffe46d3cf8aa9a2a57
MD5 e8c45b4f45fc759d778bf586ac52f0a6
BLAKE2b-256 308521ebe845c5a60d568441fbcb03dfca043638cbdb770e3ec2ae95c38d9f1b

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