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

Uploaded Source

Built Distributions

sentry_cli-2.35.0-py3-none-win_amd64.whl (8.5 MB view details)

Uploaded Python 3 Windows x86-64

sentry_cli-2.35.0-py3-none-win32.whl (7.3 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.35.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.35.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.35.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.35.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.35.0-py3-none-macosx_11_0_universal2.whl (16.9 MB view details)

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

sentry_cli-2.35.0-py3-none-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.35.0-py3-none-macosx_10_15_x86_64.whl (8.9 MB view details)

Uploaded Python 3 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: sentry_cli-2.35.0.tar.gz
  • Upload date:
  • Size: 200.9 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.35.0.tar.gz
Algorithm Hash digest
SHA256 202b54ab11a33a4ea7f5680478582e3888ad410705d84311fe23392081ea7170
MD5 3b89e91e311bc1210c3d5421b4628248
BLAKE2b-256 0be2addccbab6d98c8ed5765740d7ccaa07cdf4473dc5fd521865c7b59c49320

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.35.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 1f2b0d08bf662e6752835bb03e3b82a09f5c01db5c623b35bfc16b8bc965038f
MD5 787468009624ae8c452140392a09d84e
BLAKE2b-256 76af0ee6743adf6ab9f800ae8f7de113c499ed6916aac494777d10055cfb4f01

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.35.0-py3-none-win32.whl
  • Upload date:
  • Size: 7.3 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.35.0-py3-none-win32.whl
Algorithm Hash digest
SHA256 4af395d7dac86edac999225976b88c9b0366d4a8507bb3e044540c61ec061e5f
MD5 7ab49dc84d99c6ae0d012f08aca10596
BLAKE2b-256 9140057a1563dabf81fa1acd9ceddfe7f2f1426723c894ec71d771d5b806ce4c

See more details on using hashes here.

File details

Details for the file sentry_cli-2.35.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.35.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 5665e34d622559bad9d7113b3e3cd43ee70389c18c4de0fe2a0ee81859577d6b
MD5 fcf3e632a735aaeceda11722067c8ff3
BLAKE2b-256 5adc4afa2838f45ed80fb9a598cd0d23724cd5a89b2422104f634d09c40331b6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.35.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 b00465fd0661a09fb9317d47b25a362cee21c4bce3bdef4ca18a62459b21f9a0
MD5 483884a55b1e6a193146e4321c33eed9
BLAKE2b-256 e437e6498000aa3e50d3b83c2e2c3d2e0a312a287ef9f6ac697065469353320d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.35.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 18a4f60bc2b09d98d9fbf2015f8edba4c871b2e0589c1f65637b38522d68390c
MD5 5808347c667a56d6be80ff5d4c734919
BLAKE2b-256 2ecbaebe44d9704426dd0c8f1b5879af647fb3ffe91e7de190d0bde51e6668d0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.35.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 b46f20c7b3ad69935c48adef03d29aaf4cc63496e7721881a59bf187a8ed0b5a
MD5 08bb57fac4ec7a8b00c70fa854a78a55
BLAKE2b-256 fa7ac2939b03b1baef429a0eb099d60b65cd5a2ef781536b5d03b4b3f9d95519

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.35.0-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 ef0cc8a37eaf6ea16688ca75cd849e4b521e7c4ded5748e064ea0782bff04f5f
MD5 e093d103b178eb2b76c9dfb662ec44d3
BLAKE2b-256 f19c6426e151b53262f100571e5a4d351bcb3abba19800ce5896f344a0abc612

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.35.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 8dc481ad0436b4db4b48ff4a5e9678e3d6360aa0906a3ee337f89e5c41dc9ca0
MD5 fdd9eb2d3d217d79143db52e5dd47598
BLAKE2b-256 abdf366360b1fa1b360ff6bf0772e234728da5f794622209e10b6600708c7bd8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.35.0-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 442f67a0ba15d6c8911039c8667cbbd92443a39a0f573e89ad03d807ddc914d9
MD5 5b284b844daba1a7c32ebf1f78793fa8
BLAKE2b-256 7c0fbbbffcf8105e9c2b5937398cd42c7da12af2d330f7733508a7ff3698883d

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