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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

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

Uploaded Python 3 macOS 11.0+ ARM64

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

File metadata

  • Download URL: sentry_cli-2.17.0.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.0.tar.gz
Algorithm Hash digest
SHA256 2271d546b19e72e13ea61cb7cb27d48f32242f27a3c69686b5fed0339f8732bd
MD5 208183a6357046eb73425cd85e782136
BLAKE2b-256 120dc1d944d663c8578dc97fb1db5a7366ab3abb1f91ed2dd1f013eca71f6f67

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.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.17.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 929bad8241901ba7fa3c9a8ff5ea58aece6947b2e45c2cc92cca2819dbb52ac8
MD5 ffbb1958873ba684b28b465dc42981fd
BLAKE2b-256 ee59ae5ee71ceba31c2d0442eed93fbdbe5c1502c18a7f42319153f495d1abe6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.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.17.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 022f05075f4a73ef15964ef15f65ff2d56b78d9d2c539ea8ee7e1c73e3ba4d62
MD5 7389c19477652011dc9135dd603eac32
BLAKE2b-256 8103ee94a37b9185be80ff001cfe54e22c918bfa1ff5254d29f4f6770d6d69e4

See more details on using hashes here.

File details

Details for the file sentry_cli-2.17.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.17.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 d24a80171520243dadbeeedd0cdec1f64eddf5a09f3dab38af6bbdfc9c3c16e5
MD5 64706144c2ce90115114310f9fac1e7e
BLAKE2b-256 55c255a37fbfd3a7f7c51210642f34d6bb59d17f0c294620f100aeacfacd5348

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 54d8e1b9cc2eb6097f6cbc9ec00b0c8b9c6f78bad5e12b752b11ab7c837cd74e
MD5 02d163d94f6ee07db5c9ae01005a4ad3
BLAKE2b-256 ef3ff2a0aa3ba3ceaa2cb69680ef032a84c5d4ac477d5477710067d2575105bb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 e86aa4c23539155462902dd3cacc447f051cc91b57297c206cc5c0ffb1f63aac
MD5 e022debc677719a6cf8849dcf47a7c30
BLAKE2b-256 89828f66502b5e97237af5dd6d3a95bc74877e2c209c9df86b64b3efd4fe7632

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 63e8ba8df2ca40a372f9ce0a686a4b9a6ffe55680d9a7ed7255695fdd47b2266
MD5 18e0d2ad11ea48a495e4aba90341f5c6
BLAKE2b-256 3ee9f6663eac9a4d170576548599265232a51083f3a19ef8a854b6d9a3db2e81

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.0-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.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 12b0088d3f8525af27a521bc2bc38f6182738fce40e6b9ebf542738769073968
MD5 e1de30e5b64c181bb4d43eb42f01e89b
BLAKE2b-256 7e7b5e38fd81fd198e3cdf5190b2ec3a98758033b0d1e0727dd514edf7a0d06b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.0-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.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 891bc2df381c6070f2784442236ac6cb0cf8e5d84b4f71c8eb67fd341700692b
MD5 69ccc25349d5d18c6305689892dea8ed
BLAKE2b-256 788c4b746573d0abc2e8826475a7ece489c3dd75b0fcc5470972228e4e017766

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.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.17.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 d3989bdd47ba79eb3d9c10f9b8d05262f557d1a75b1586c757e7d64c1edf16d3
MD5 37f1b33de5d21e4d48637cee925c74cb
BLAKE2b-256 d7f73204f74c2af1fb469a6d42aad84968a2b9cefeee959ec2dfd5d29c3e1a45

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