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

Uploaded Source

Built Distributions

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

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

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

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.15.2-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.15.2.tar.gz.

File metadata

  • Download URL: sentry_cli-2.15.2.tar.gz
  • Upload date:
  • Size: 170.4 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.15.2.tar.gz
Algorithm Hash digest
SHA256 a047d95ffa0f016e8e6c04dab63af770f36c6ea8e761f1beef7a66eec34c488d
MD5 b5804b82c2ec64453f7345885ee4b63a
BLAKE2b-256 d045442782d3720da3da1323ea95ca510b9a4375835dc88b6e24484607eb014f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.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.15.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 341dd8a4b7d93e6b3017dc00fe3dc3132ef20218f9537cf2c6a3b1cf439cff31
MD5 0fe09b85c3741703056b3b7854c29e7d
BLAKE2b-256 400e96e8767bf9ca946f67a9d78c7eb600e1eee0b49a433883abc3330cbe26e4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.2-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.15.2-py3-none-win32.whl
Algorithm Hash digest
SHA256 fe9e713f486471cef528f7472a5b37d4a51acd2c202e8ceb8d85b856cabda199
MD5 a1baaa67b20862d971c0b6b1d4bfdaf2
BLAKE2b-256 4c659f30e30124793aff1aeb0eb72768aa9fc6417bb8b9ab725271cfa31fdf68

See more details on using hashes here.

File details

Details for the file sentry_cli-2.15.2-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.15.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 0794002e31559b6b9f7f769bc023520e77ecb18afe6751b92a7367cba2eaf68e
MD5 bebca01359799eb90acfc9ed00c74c90
BLAKE2b-256 ba5e99e8294e72b6533cc5e4a8b332e6e1ce5d852bfd7d5db771101ffca67e7e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.15.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 be4e8034960929e24b4f4f3c3427a72c4ac8d010c3502bd2af6c3a40d6327111
MD5 caa67864557bdabccb8c39c8a80d0830
BLAKE2b-256 cac98c9488ecaccfaa238305b572cda06c2d64e6ee5e2a582c7221c9cb3431fe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.15.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 494d20f4676fd51dfa9d52d73c48b27d06291aae3877fe1ee7cadbcf4e408b1f
MD5 f4061564110a9c61214d6b7e6bbc9bf0
BLAKE2b-256 82885f361d1f51d85072374f78aee86831b691f471c281b84dd91a575160b96f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.15.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 6f05d9229395d02e6cb9d3aeeb8f51aad9a6906902bef8b7e09e53566fc48568
MD5 8c91104afe2b65b73bbcf4aae8f889b2
BLAKE2b-256 6446fb3a304363caf00bba5841c1b138372ec9d9219db2a76d150877c91885cc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.2-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.15.2-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 b37aa3b8f86c74140a1abb5ce1658cc17878c31789b733b26f2b144fde0600ce
MD5 518e44bd68a1ed754408316dcfc490cd
BLAKE2b-256 b5c6d75fd9ebea24970e59e56d9dd368f7caf080a1334718fb7edb38c5b37004

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.2-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.15.2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3fac4a08ceace882595aa4b3626991908d808a4e25871e73ba9d347b8e197515
MD5 180b10e680a92803a2c61714282a9f9f
BLAKE2b-256 19ad7e09562616c022fd17ee90d6f1c7ce08ffda42760d18c461db0b655987a9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.15.2-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.15.2-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 0c0ccfbd997a7a3aabdcc829ed9b25957d038833aa8eb64f19c48c9a1b322d33
MD5 fbba18c1e1c12a95f49910879590cc24
BLAKE2b-256 b52218e317987c5e73c28b0492154403d56072f81db78a25fc1d9a4c9376c208

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