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.33.1 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

There are a few environment variables that you can provide to control the npm installation:

SENTRYCLI_CDNURL=<url> # Use alternative cdn url for downloading binary
SENTRYCLI_USE_LOCAL=1 # Use local instance of sentry-cli binary (looked up via $PATH environment)
SENTRYCLI_SKIP_DOWNLOAD=1 # Skip downloading binary entirely
SENTRYCLI_NO_PROGRESS_BAR=1 # Do not print the progress bar when downloading binary (default for non-TTY environments like CI)
SENTRYCLI_LOG_STREAM=<stdout|stderr> # Changes where to redirect install script output

When using sentry-cli via JavaScript API or any 3rd party plugin that is consuming said API, you can also use SENTRY_BINARY_PATH=<path> alongside SENTRYCLI_SKIP_DOWNLOAD=1 to completely control what binaries are downloaded and used throughout the whole process.

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.

Update

To update sentry-cli to the latest version run:

sentry-cli update

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

Uploaded Source

Built Distributions

sentry_cli-2.36.0-py3-none-win_amd64.whl (8.6 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.36.0-py3-none-win32.whl (7.4 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.36.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (14.5 MB view details)

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

sentry_cli-2.36.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (12.1 MB view details)

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

sentry_cli-2.36.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl (10.6 MB view details)

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

sentry_cli-2.36.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (11.4 MB view details)

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

sentry_cli-2.36.0-py3-none-macosx_11_0_universal2.whl (17.2 MB view details)

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

sentry_cli-2.36.0-py3-none-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.36.0-py3-none-macosx_10_15_x86_64.whl (9.1 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.36.0.tar.gz
  • Upload date:
  • Size: 201.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.2

File hashes

Hashes for sentry_cli-2.36.0.tar.gz
Algorithm Hash digest
SHA256 6668a1e545f084fb80a317e2384eae0b34e4c84833d914f59c737641b406de1d
MD5 81746ec31fa6c3440f7e960d3824a359
BLAKE2b-256 e181c8c907e92acc8379316ce082d83ab2cd1cbcd35b5d7dacfe59e5d7d79e33

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 e90113f412584d7dcc823000a5ab2e747ea0526355aa32e6a3ca9c69bf1317da
MD5 a2aa7b4d4f77f2e886681a420cdbd74a
BLAKE2b-256 c44e8aa08ab42c0682bd14c6939048e28bef30f35dfd0420150180fdc9102e59

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.36.0-py3-none-win32.whl
  • Upload date:
  • Size: 7.4 MB
  • Tags: Python 3, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.2

File hashes

Hashes for sentry_cli-2.36.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 a82a99d19c139c54a9aee599fe390ba45e26483005cecdd3a94e5ef181ee54bf
MD5 9b4dcf5c009e91fa5d6388806f08c081
BLAKE2b-256 9c1c8f4be058e63086bd1ab1b0bd57597b1f72cd5990d2df42581386e5706a67

See more details on using hashes here.

File details

Details for the file sentry_cli-2.36.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.36.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 b7bdf960502b3aaa2ae2ec719c267e93a9e77c8d476d40f040d018fae5306ffe
MD5 de822bc76cea7dc18e07814018900b89
BLAKE2b-256 0bcb97dbf5ddf2602e7331b837cdbb9c5d4add4c599cb57701d278fbb5cff8cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 b78f355bb984387a9f33c2711a40b77bcb95c28def346486a8a0081f01c81fd6
MD5 fb0407b6d9523be8c038c28f7746a659
BLAKE2b-256 5b731a4bb975a91ead5bd74b1faac015be85a661509441c9f67191c72e7496cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 fd1aa9bfa639d14642ed9da578ea615bb4b94fbfa9b31bf84ad7e29c6a95eaaf
MD5 3e77515e9da3f0e103f987ed2ef7752d
BLAKE2b-256 afb80dba1d2df3934aec19891cb1f9d81b015aed08e9faefcf0fc718345ed4fa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 889af8b419c1cf536a6de26631a764ee8ac39b12df81faad94511aac611e145e
MD5 f43c91a43988c77654dee77e095b617c
BLAKE2b-256 a2a285f57a58673ce4a0e123d81b676508794914720126dac0994b82cd95bbcc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 3331c86b5287efe0f3500500de4082001cc7ff1c2ba697cde5678dffe5d13b5a
MD5 11db1eef3bdc24b56d0e4bf4532fc710
BLAKE2b-256 ea0606dfa58c7a35c4f6b216856f7761bc2c08874070ffd60c4d21c576025475

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 be0c66fe4e2f8b842f56f52433f0ce14a0af201bdb3dfca6e0a02f37105eab52
MD5 e18f8a5b1612f21567b6f38a4487cf3e
BLAKE2b-256 924cd1fdb30b76189c721707ac655c10e16124c25c72f789b5b1034c40693491

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.36.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 7899df3019a43581795c32057993b2b8a8e65deeb4e2a9d7de80e1a2050bc752
MD5 dd43df1948a5a5917f4fb13efb25d40a
BLAKE2b-256 976f2d8ceb009a4d00d9e598d35f4d10592a3637835bc6406560557c010b09e1

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