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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.19.3-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.3-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.3-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.3-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.19.3-py3-none-macosx_11_0_universal2.whl (27.0 MB view details)

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

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

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.19.3-py3-none-macosx_10_15_x86_64.whl (14.1 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.19.3.tar.gz
  • Upload date:
  • Size: 177.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.19.3.tar.gz
Algorithm Hash digest
SHA256 4f22101f0fdf40005693426846aef0a885de0763075c6aca606cd322425c2a03
MD5 ed6788d833465243b15346cdb4d6e4e1
BLAKE2b-256 19f747370389a95ec50893dcc0081320b7582c458084148386bcf8fc28ba56b8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.3-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.3-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 83841be3f35565213f6faa29ab62de4cee3b2f2921f513440b8b1043e1d6daaa
MD5 b7e9099b69d5bd0bb1bd7e463ff58191
BLAKE2b-256 afad4faa4c81a1e53bafb92d87827445891b0a21a6ce700a9b89cc18df35c4fb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.3-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.3-py3-none-win32.whl
Algorithm Hash digest
SHA256 442aa3ea41393aebab41230841f0ef722d90dd5f407a1f39f3161d82d9cfd476
MD5 390deea920456a47a033ab94dc4a2a2c
BLAKE2b-256 7ada964ad00d168df7c2757e15dbf9d26a7214b57c5d7331f69cc84c2b26d9d1

See more details on using hashes here.

File details

Details for the file sentry_cli-2.19.3-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.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 3d17a6b8e396481f856423837b87f6c6a5fcf12c9f661ea4b06b558c19480120
MD5 be5776b6ca61ad8b973cc200dcf34a59
BLAKE2b-256 b6083a2048c06dcd895f052f30365dd0ed68203b3fa57067637e712dd1f3c214

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.3-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 f1c1dcd4510b14ae382f27eda865aecdeba4df325c4643519a1365586b2e2cc2
MD5 cd7f4f6c838c21a7a854c0b98940e603
BLAKE2b-256 34af29abe6f2e1a667402fa598d7e3eb07e2b0b7215ec02fe7d37e29d10bef20

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.3-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 8a162c5a399a0c24c171fcaf42a20802da8bbf99c9f20598d8859694d6854011
MD5 39d8cc392f2aaa4bf00745b505789bfc
BLAKE2b-256 f23821e1a61ca34ec1c941cc261d1a76f1080a8fb6c25a8925b2bf6ef3c8eb0f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.19.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 08d4019109d3cb04d8fd179d5fbb574ec00609cf974981314ae983ca22ca338e
MD5 44cc996023790fbd1642e2b075a68140
BLAKE2b-256 793a03e199a0a5e5bbd21be29c2672ac7f52d09905114018a87c8f861ab27ebc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.3-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 27.0 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.3-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 4ba78588e7ae1c46a962623a9db248cf67701a706e498ad2f515611c068513af
MD5 40bd1889f047cfc9c7c34e65bf1df58a
BLAKE2b-256 6edf377e30d5b6ebb575b226117128b10ad29157da585b9af597619dd19034cc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.3-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.3-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 6f52c55927b5812162113e086d0245cc9ec21e6b8a87c77db87a8ee94abc5be2
MD5 b8dc06f4132f41013e7955ee289a009e
BLAKE2b-256 895155be4e12e3a76bdd8e6cac936fe32e17a1855201684b29a301b6a6e3d649

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.19.3-py3-none-macosx_10_15_x86_64.whl
  • Upload date:
  • Size: 14.1 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.3-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 5421bd30120265ff023021f2ba769f7fa70a78d30cb629c7bbc6378d8c702b63
MD5 2e8707e6b376fe92f1a1c6e977f8c375
BLAKE2b-256 2a9b4388e978eb88ba43016f933294c360aa21c96354d9fa39c952952a22a496

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