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

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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

sentry_cli-2.14.2-py3-none-win32.whl (9.5 MB view details)

Uploaded Python 3 Windows x86

sentry_cli-2.14.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (20.9 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ x86-64

sentry_cli-2.14.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl (20.1 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ i686

sentry_cli-2.14.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (19.3 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ ARMv7l

sentry_cli-2.14.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (20.2 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ ARM64

File details

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

File metadata

  • Download URL: sentry_cli-2.14.2.tar.gz
  • Upload date:
  • Size: 166.2 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.14.2.tar.gz
Algorithm Hash digest
SHA256 106d4029b2ba2c9601660e3bd562f2c3c1dcd307534e118da99a4e611ca7293c
MD5 895ddf759ded4371b80dddcb50fb3bae
BLAKE2b-256 0891f8308cb0a8b5f207fcb5acb5d1c813fc3a77c7072475369b7e72349ba439

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.14.2-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.14.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 a3d228739e4fe8a7489fb679ac3df823046c7bbe2c1317690491b54c3e87e75f
MD5 a2fffccb76aa570fadfb53a9b3086871
BLAKE2b-256 1fe890b9df5c399ed1b630463fc4e4555c2560b6391c4fab38b5e8b9ad3f89fa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.14.2-py3-none-win32.whl
  • Upload date:
  • Size: 9.5 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.14.2-py3-none-win32.whl
Algorithm Hash digest
SHA256 58227444b10d40086659da1e437ec827cfee0c4fea79558eb44e1a7b486d288e
MD5 f2c7d0218a26b6403b466c82d0cf2853
BLAKE2b-256 6ee041bbec42f5cd361ab8627fb780967a3814fcdbf972f093f09cc6b2724ebf

See more details on using hashes here.

File details

Details for the file sentry_cli-2.14.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for sentry_cli-2.14.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 024571bd61495795d83bf63c44724637142c774f0399b4fbc597c2bf3c40fddc
MD5 9e19048b2699b52697c78b7c8762e28d
BLAKE2b-256 bd56c13db6dd26c99261f08e7bff87f14aad8372f28868299a13794ed503a252

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.14.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm Hash digest
SHA256 dbce48f127a30a159f0c36e97afaa289f40a2c328b6bf7a938aa1ac20c6df71d
MD5 e660b9f7019c7a729bdf1a0eb46f80e4
BLAKE2b-256 283b73bc7b7f78a7a4515460688c37639df53eefaf8aca300561275f2d237cfd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.14.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm Hash digest
SHA256 6510cc34ce13b6419363e638fdc82b8107690c451c74a750035d5e17d5049ee0
MD5 516dc97b479bdc788a1aaa571f781a0e
BLAKE2b-256 c095533870eb09a207b61e1c5ab0e5e8b5be56bbd66ee87aec2332a6f481c99c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.14.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 4cd4228b49fef2f7496e3d1f7862170c0b74b1375b5b7c6965548298e0d69cab
MD5 da27963804cdc761b26b692c57bae9a1
BLAKE2b-256 152b8d61ac6e616ccddfbb082327e67ba6fa85b67cd8d3dde3d4c173ed265953

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