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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.17.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.17.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.17.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.17.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.17.1-py3-none-macosx_11_0_universal2.whl (26.7 MB view details)

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

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

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.17.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.17.1.tar.gz.

File metadata

  • Download URL: sentry_cli-2.17.1.tar.gz
  • Upload date:
  • Size: 172.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.17.1.tar.gz
Algorithm Hash digest
SHA256 240ddbbc8f046b2a21c8945038dd3df4ba96309656be6f85b93baa784431497f
MD5 62817f9f2dd7d98a86f9f48d63ff1138
BLAKE2b-256 dad2f7daf1ed8b39f7b2af2913858bb252784e6708ac569847697f8a96be907f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.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.17.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 c0c9171ab0af61514e19ccd0d2b484b36354bdac66f22992954492b6e325606d
MD5 cbb020750a00929428b49c52c7962f6c
BLAKE2b-256 7d9f1a94092960ab0ba9257ebc346f240d4ab3d465479ac7ee62ed67d9637046

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.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.17.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 18844b87b2cc57f51fbb6a46e5648224e62006211939b43c7ec7d6dfd10bf17d
MD5 6da0ac56b1519248bc25e4f7da84bd3b
BLAKE2b-256 ca9fed3268c9ce1beefd58b3b22bc9d2d118b69f3254344c1571cb40ce2c8705

See more details on using hashes here.

File details

Details for the file sentry_cli-2.17.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.17.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 ed6e7841dd9c28085d256f6a031ed8a85c995b2c11a6f21ce99d97b885cb8186
MD5 c227e7921e69d2c5034809262a814faf
BLAKE2b-256 ff0b1d2cde601ec3151db0ab76953c173530a47953a166404d0f711a95b779b2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 22034d9c75fb0c2a0ffc0b847a4b03ebc0706bca2074399e584fb17866e074cb
MD5 66753bdb701ad42dc9752a73e8028e5c
BLAKE2b-256 24caddbe9b9e246ed99e46d1afddc20ee8d640288d62e751ddb036b2424a0618

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 1898ee86cc226905270415d197327808c1df908c6f4d0d952ae03e8655e8bb0d
MD5 e40ebe912257672285b709edc7b9abe0
BLAKE2b-256 f440fa1f3f26f2a90380c3653fbb8f1963fffb98a18c42550ae140845913445e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 fcd3e77009fac09bfcf7d80109784bbcb539f062ab689c0476f50e8250999352
MD5 9fdba3bee8f13e6c19243591c4639c35
BLAKE2b-256 3c49f893388ef0e2508c6323b7d2719616fa46cd1b99cddfd21a153058500699

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.1-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 26.7 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.1-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 9a136ee785c2c3a66a66f1fa84aa67a503d7e118920dfa0b2df069dd95e00c14
MD5 a8d4acad117b9a7d5ad297a413659cc0
BLAKE2b-256 a90d9f31d89cf6b2ed525d15794ffe53d862ebbe0713f829bc2ceda7ec1e4eeb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.1-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.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 376697de8d41f1bc516f5db70410fa3561bea9c62e69d866a93c2521760c71c1
MD5 780f706f1d3384af57d3771193bc7c10
BLAKE2b-256 c4fb89fbc81eadba9c7cc714b8ee1ff33633804be9bdee5d549b730bbfdd9794

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.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.17.1-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 41ec5460b8b4f26bb4ea54765b4d168a0e9f20f14152539d425310ee64985e34
MD5 2d300492d30231ff2fbcaa8e1b6b31f3
BLAKE2b-256 0c8e1208b6d0244c0c9e6857d5cee097815bf3a21003ef9f444d0759eedeb98a

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