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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.17.4-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.17.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl (20.3 MB view details)

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

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

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.17.4-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.17.4.tar.gz.

File metadata

  • Download URL: sentry_cli-2.17.4.tar.gz
  • Upload date:
  • Size: 174.7 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.17.4.tar.gz
Algorithm Hash digest
SHA256 a33367eb91d9c21e043b037c8eb110839f67a3bbfbe39eeb6c72cd221a1ad351
MD5 64ed2894fd7dfebaa71b6c9bc39431fe
BLAKE2b-256 6b242f159428cd62a5380a38d5fe4a8b7421cbbd114023504b74a19de51fcc68

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.4-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.17.4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 b35d8367b24eafaed6f354dd1a3799f08249302aff2c1a11cb0f6e0eb362e653
MD5 18d101ca8bc9fe5c7145d6f93a59df90
BLAKE2b-256 fa868f64c775c1772d621147a9c2837a64b2d1217bc96b8258b8754e3f46cec2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.4-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.17.4-py3-none-win32.whl
Algorithm Hash digest
SHA256 9fedaf573e9fa51562ba112421dd0bcbda230184882b43b28e55f1b0aa844958
MD5 eb1ca41100b831a94d0639cf3242a148
BLAKE2b-256 fca3c2b86f8f082eaf430f3489c5217d32a4bcb60f40f6418fb3f454a136581d

See more details on using hashes here.

File details

Details for the file sentry_cli-2.17.4-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.17.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 5b58887d734b35dbdfb9ccc06de9a74a708e4ed36739fd4d91085f9c700f9b50
MD5 45243fa433c4d6621d3dcf76b51a6b73
BLAKE2b-256 aa642c677be5b75384b8c07f986c31d681de88904410fae1b4c1460d66a73ccc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 da47b8c46f3848d8c4840336a2e1f0667e5cae4019e555cbe422078a0b884525
MD5 f6a994a70ac4daf4b2892006b7074a3c
BLAKE2b-256 9a0b5511b38650fd475df7bcfb31222100c0c8ded7d03f551eb8dfe906204d4e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 4fd2133a49a5a8f6f2d436ecc74473718aa56d406e91c3959802f9889834c71f
MD5 1fbf8b21a0e4edff0df4b49fe0f08306
BLAKE2b-256 106d4ac174028f28819194a6e28c9e89d29f8e74fce61f2031ac6b08d9557066

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 9f54ab53f54d7b186453df9740fd2aa75c05b7d7424a68cd3a53eba74514e67e
MD5 a33918571dcc9ba07d1cd3b83aa525d7
BLAKE2b-256 0c74b5d9682021c7701a690509d72d5b24c6e02b192851a2dd6e6b82dbdbb98f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.4-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.17.4-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 7d52e2804daf3d91ebc16d35633685c4db0be23bab58465f86ccd6acf95d3fdb
MD5 f69da797254fc4ca2444ad9f74be0778
BLAKE2b-256 5f7e6bbea29f76b2c1be63f1225fb1ca78154c69c50bd3aee029b6dcc85c8e95

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.4-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.17.4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b6be6ee594f285f38aa8258013f0dcfdc5dddc7ad8fb9677daa1acc3347cf451
MD5 5963b519e94448563fa3c341e11d31bc
BLAKE2b-256 584f709e6d1275447e77db6f87ee095e39c037ca464a4da6061186de8e993970

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.4-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.17.4-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 2ce196f9452264ee3395c408025cb3472857754c1d8d20ff7a6003e1d5258c4d
MD5 957298359b3ed4b1afa4b5e29aabb8e1
BLAKE2b-256 a67a6928d494978f02ce2540835b1a9ecf65857b0a9863ecaabaceb5297602ef

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