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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.18.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.0 MB view details)

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

sentry_cli-2.18.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.18.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.18.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.2 MB view details)

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

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

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.18.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.18.1.tar.gz.

File metadata

  • Download URL: sentry_cli-2.18.1.tar.gz
  • Upload date:
  • Size: 175.0 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.18.1.tar.gz
Algorithm Hash digest
SHA256 f233c7ba5ff4a130e0deddc59f0af15885203a2197a95a641849faf0459f4fc6
MD5 ba22b54a56106e28281f4bfc0dbe691f
BLAKE2b-256 24762912d503fd9d80901e0f044471ecb27cdfbc927ed3ee49c22ee69e3bdb1f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.18.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.18.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 3e8db5eb065c0e47dfbfae18e969acafccd78212584bf56623d8b21470700d35
MD5 bd88b64e8731a373e740f5562a0e7810
BLAKE2b-256 6c79b3a1cdfbac7d1096213418e62557401fe12fc693cb928802158c589b64f0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.18.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.18.1-py3-none-win32.whl
Algorithm Hash digest
SHA256 aa118d9fe053edebb9e787fe4b097dcd2a17898bdd1767390b0aa22a54f4d877
MD5 80e5d8ccc435de95f42518e171e3a5d0
BLAKE2b-256 e00b8ec3f96d6a5835faaf52fb8231142fa074c34b532fbf03b3b1b1aaa79f10

See more details on using hashes here.

File details

Details for the file sentry_cli-2.18.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.18.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 117f442e854c77134063a2587dcf2bd5ba3884269c209b8bfe69c7ba431bf7a9
MD5 f414562955234f0740f56c810c4465af
BLAKE2b-256 915ebbdcf1349411a61a3bb0aaf6ef87fc49787fb231fb789189d287ae1dd32b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.18.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 8b83b263ca42a57a23dc660e0a24c310570843eece972bb4bf68884562692792
MD5 c29bdebed733060fc6f3e1b6fddb673b
BLAKE2b-256 b211e8cf8de95c58f23b5bb462c08319deae8c93d1603aa9972ac8db6eb2af81

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.18.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 0fa278b74a54c03994f018c980532c23fe2882f7acaa186e73ab0d95fae2b590
MD5 f315e740357a3a06f02828ca6e848874
BLAKE2b-256 bc3a671b45a1b47ebf15daa8f8735ffadc56f14a758afa68521a5efdf6913f3b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.18.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 200e16dc2e01ec736199cd31e4dda1c6f09fa83c0b3b9c1228172c5b44d21108
MD5 5241f735f6de42b21c610c80385568ad
BLAKE2b-256 d1441a8ddfb3fb855b0679c87efdd571a57e4852bd863e87205bbc0134f4e9b7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.18.1-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.18.1-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 23d651162c2e17cd5ce8e0af6e65c374a12e01f3a571bcc910d75c593c838c75
MD5 411fe0768d215e118ed34e703d07d2e8
BLAKE2b-256 ec60f25d26b1c984dee4fd4953fe92a6084ae2a535fb289497b310a5bc333b01

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.18.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.18.1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 59b94483070a6117605e641bc845a4c8c19aac829eb50d49dab8645eb497620a
MD5 b1c96a7d9f1ef02d542d45180972d2c2
BLAKE2b-256 51f757b675cca02be9c6ee68ee7f6859d146d4d1bfaeb6d25c61e3264beca091

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.18.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.18.1-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 bcff047baf2b97dfb84758710a7f8bac8fc84d3ade59cc823edd6922e94f697b
MD5 b9bb65bc16d5153cee37a39c8e334a54
BLAKE2b-256 d15c40791d1e0863794fba8c71a8ad1108fb029546ee3621907212a8020d82ca

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