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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.16.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.16.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (20.2 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ i686 musllinux: musl 1.2+ i686

sentry_cli-2.16.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (19.4 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ ARMv7l musllinux: musl 1.2+ ARMv7l

sentry_cli-2.16.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.16.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.16.1-py3-none-macosx_11_0_arm64.whl (12.7 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.16.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.16.1.tar.gz.

File metadata

  • Download URL: sentry_cli-2.16.1.tar.gz
  • Upload date:
  • Size: 171.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.16.1.tar.gz
Algorithm Hash digest
SHA256 b1b6da59231f81798012a5da819f5c366708a38da69b11eee1274c73cc63c4f2
MD5 a7aa98ee6c1b5dc762bbf975a5d660d5
BLAKE2b-256 01ffd28a567c39c89a65c355c958ec09fdb8fb6bd8960a653ac09b8180a8f162

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.16.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.16.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 014a133c0e2cb8c5ba0de5ae4e99176d26f7b893d0b297402a8ba6c972d67a0c
MD5 be5f08fe1f1cb0212e9eec3501b4bb7c
BLAKE2b-256 00544888e43c6b3c2a66b59d484f42b5b5adb56effee23b6c590544c727047f7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.16.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.16.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 e6937bc73a0926218feec9afa5905d4b833c64c9497bdb6614cc8c2c8002a556
MD5 e00dc628f121868f0e9b119808759995
BLAKE2b-256 199c64f1d5f9cf284e9239553970569da258bb2d56a26487a16edd3e87f402ee

See more details on using hashes here.

File details

Details for the file sentry_cli-2.16.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.16.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 65c37832f0610585e07ee7301a722b279a712c2d81589eb46866bd361b899fbb
MD5 8b5ad09dd734d2cba5d46079320f3b32
BLAKE2b-256 40f352acaaa332c725a1d34f1fc22b6d4fa64d99cb403fe925e7f8f785c04360

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.16.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 370b94ef13cd8f73fa884437ad5b7bc210e75b85d0f334939253e7cd1c150158
MD5 c43c673f524ccf7bc65c02512532bb0d
BLAKE2b-256 f93f679e927e55def7af219aa3f70c2de8b48c07ef95ca82b94d1132710f0a51

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.16.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 c239ec41a216b283d0b100819652b3a71d02c265cc7bc6d281e4f7483d85a13d
MD5 d6088a22213b4f09b272f8b19d123f02
BLAKE2b-256 6da71025fe632b88c56f545fbc42440ce8cc65dbf83ae76c248c08e506b337a3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.16.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 c3c59fe7b72e22741067be30ab4e7e6e9df34681b28206b4890362e893543f5b
MD5 5f6eab3dec9f10ea4f1e891662780d74
BLAKE2b-256 f0f954b81f83169087b05ee155ae951b9073ebc87675a174ac80b123aa37bc70

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.16.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.16.1-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 74af197b130de28e625f3126f1a58871c04e4ec397b0bb86ded0670a1b90211a
MD5 d713d77b6d65e28751d9f6d189cd829e
BLAKE2b-256 c853219a23ac54eb05ae960f831d84520bd66ee821cd0dc904dda2f9f61984ac

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.16.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.16.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c0b81cf63de8f2ad4d9ede0351adb9c6e26d9f9a40de2c905bb42f3cbcdad96b
MD5 d1b66c53c66242844293f71a4d2e3797
BLAKE2b-256 6e484bd18dc6632b6e09b7ee121a207ecd254449097110f7607144922f2d51d1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.16.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.16.1-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 24422f38e1247dc845e47d333e21316ca594747f982785d2892832a337e63a87
MD5 304cd87bd86367e7c7f7e77cd3982275
BLAKE2b-256 0869248a90536ecd2d8a0e548cf9fa25ae6fb35fcbc6f4d25efc879ba9c9f101

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