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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

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

Uploaded Python 3 macOS 11.0+ ARM64

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

File metadata

  • Download URL: sentry_cli-2.19.0.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.0.tar.gz
Algorithm Hash digest
SHA256 d306ccb1cbb5a70630cebe7c4a1d0276883e49da95984a321ace4ff6929fde43
MD5 bc02ca4f58fc558c24a0b135b7ccaec4
BLAKE2b-256 a99b7eacb655ffa47746f9c4aa74cd2a0b1224ffca6a6f50d17a55c9c71765d3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.0-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.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 c5a94a1e8a5b2b4c25bc733ac3abc239deda27c5bade524efeaa0a6e168bcec2
MD5 f9e0c03e5475323aa0c9184ad36f5896
BLAKE2b-256 b24041e52cb3549a99045c547d3d275bfd6fe62d8dc10e9d4912305fefa3b9d6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.0-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.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 39cf2d42d6a52a62ad66140ff54489326964ea9704519223186e47874004cdac
MD5 51998630103c19d3e813ce2f7b083454
BLAKE2b-256 dd0e33db8aaf9d09e44495f6b9e3cd0f77bbf4ae46d0e040c7707023ec9e9dc7

See more details on using hashes here.

File details

Details for the file sentry_cli-2.19.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.19.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 3a942c5c3fa39b10be0edc3928835030de64a7c23afa9067f864fe981e4dbbe7
MD5 8126fe0ba2b1160487c04cf98dbd7ef7
BLAKE2b-256 93e5f969a19d1f096dc59ab37da9bf25c6fe78d1299e1a4cad722c6a49228564

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 a3f9c6d6d94ae5e81111810164b8ad786ea0909680c5775a097705d11c340f83
MD5 abdb9df2bfb2b2f2b51f2167d73960c8
BLAKE2b-256 df512bbe75eb2989b64f90d95fd92c2d9183f9dd5079ce87bf89353664abdb5c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 3b1585ef9e18be5acc9dcad81cd7a636002492f3b9582e6c977d1647ad0297c8
MD5 1b611b016d9bef8c3ea0ca781be6f952
BLAKE2b-256 f547343e00a78a9d8b4c0a81cea118cede5777f9563eccae6d80f4637d6678e0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 45700246fa77bbbf9c68585c1e98e2e16c8887f09920fba560b0a787cf5913ae
MD5 688106b6cf03061693dd5c8541fcb06b
BLAKE2b-256 ac6e30192c2512a567162c94112ef34eae7905bc24bf930dc6419b6d36aa024b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.0-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.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 843f7a4cf1ffb56babef95ca15794239c10de4230e9fd9e676043420e9339af4
MD5 c136d9c2525d5ba24a7386ab01f2ca20
BLAKE2b-256 48b4f5fb1702812bb861a0bfe1d32ca2242d8a1a30920b9347323d9e5b399142

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.0-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.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b4d8a3be82b472f5185fee9d04bc86d803dd0f8e34b7663c97a9a5a2cc59330a
MD5 06a7d18439cad1b01cea97f85cbe538d
BLAKE2b-256 92e144e7ff7a56995087d59d3f519505c752f43067e72fe1474d96450ceb3789

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.0-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.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 4dfbdaa7377183012e62ece8c4ebb9b0665efdd7b2fbc517c0e4748354fb7e9c
MD5 40b9bd4fd05673eb243b3c274889708b
BLAKE2b-256 a62a6593508e6e3e5808c3dc6f15f0c7fda6498840a0b87b15b778673413996d

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