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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.17.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.2 MB view details)

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

sentry_cli-2.17.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.17.3-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.3-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.3-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.3-py3-none-macosx_11_0_arm64.whl (12.7 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.17.3-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.3.tar.gz.

File metadata

  • Download URL: sentry_cli-2.17.3.tar.gz
  • Upload date:
  • Size: 174.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.3.tar.gz
Algorithm Hash digest
SHA256 943fc6f9268f0064b3adb1ac8d2fa0a6390681d7e843a202a70284b5a296fa77
MD5 9f90a4000dc20091d2d1d09cc469686a
BLAKE2b-256 e76ff7d669a36768fd0b94ce388c4d8f383ddb3e022f6dccb7860f08d616ef30

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.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.17.3-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 cf2bf23247467ae30915a8872ba1dbd39a8321630c7c23bf9efcb2cb77d6dfda
MD5 3b63e629fbc9a78b0db0541e11da6c07
BLAKE2b-256 83d18c7b955de69fa88d2e4f4ebed437c83f349037565ec2c3df8049e84c6d8a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.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.17.3-py3-none-win32.whl
Algorithm Hash digest
SHA256 1001af343f3afb2bf66585229971811cfce532f1bdb85085984f7db202f21af4
MD5 35b736c9b9fa9fcc17d8fa5563d8cc04
BLAKE2b-256 3f80419bc3a114c155ee4efc7f7d1967b130829571cc9eb36f6ef51fb4204b14

See more details on using hashes here.

File details

Details for the file sentry_cli-2.17.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.17.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 68ce21facbd7fd525ec216fd65c3c21532e3a699cacc6066e0fa5716b4de05cd
MD5 6371cc782740a87beab15b4d46b0d284
BLAKE2b-256 a2e0dd0046bed68a514a1a0f98f4cff88667a9241d2e78f9eb5bf1b18c6f36cf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.3-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 d64bbcfd6e6335036da27f693c0d0504fa6b8755a6f07938801700fd2e613be4
MD5 373154d10e93b01b25dcaa4867d558b7
BLAKE2b-256 0c468907dba159fb7a8a49a939005de2c9fbe83f3bc022a5735aae1e5d194777

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.3-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 bd9904d12dfc09fa24bc63b86d108e1fac8619cf6da3886861d8ac475b5f847c
MD5 70d3bbc7dbb6fb56947cb1e9e4bd1530
BLAKE2b-256 6fd0e3315f5e034f1030ecadeeb9a4fc27544d5830c34b077f69cafdc7d86a8b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 1e0d93b75970d53787ee3abfc166e5c6d499e7b22511a78b3c0078d15a32dec8
MD5 a53de3d9aef591e618503c22dcf1130e
BLAKE2b-256 b47c86c9a5cf14e4c9dba259fba4ae5e0d33462dc817ada20d1c87a20b6a96d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.3-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.3-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 1c3360a271b8c80f15fb36ecb0f1131e604076861699a84a525ee7dfc559fc66
MD5 18d1d46011fd15393cc7a0fddf4b1f63
BLAKE2b-256 08ebf8ca79a9f0ed3dca6f0e57e765d2db7fc2886c3c2e7ff097fcde02bed1e5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.3-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.3-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 51a71c1be214f8d7eece912b81343ea7b11c49aa5a6dd6eb5a32d039bd413693
MD5 73d550db20eec0b5bc91a37f4a3db6f2
BLAKE2b-256 3d8c04520c3e9efb07c0a23e9344717ec3fc19480fdad5efad44112a32b71a13

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.3-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.3-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 ef642159301df56c86ad46dbfdd64c611f2a288f7a91fbdfbbc6b6f4a9f70e73
MD5 9e294a7a42a09dace2c7e01a27e00e8f
BLAKE2b-256 7b4d2a6f731cc4ec924b389fa605a377c383f7a6a7597937c65c314ff70d46c8

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