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

Uploaded Source

Built Distributions

sentry_cli-2.17.5-py3-none-win_amd64.whl (10.6 MB view details)

Uploaded Python 3 Windows x86-64

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

Uploaded Python 3 Windows x86

sentry_cli-2.17.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl (21.0 MB view details)

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

sentry_cli-2.17.5-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.17.5-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.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl (20.2 MB view details)

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

sentry_cli-2.17.5-py3-none-macosx_11_0_universal2.whl (26.6 MB view details)

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

sentry_cli-2.17.5-py3-none-macosx_11_0_arm64.whl (12.7 MB view details)

Uploaded Python 3 macOS 11.0+ ARM64

sentry_cli-2.17.5-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.5.tar.gz.

File metadata

  • Download URL: sentry_cli-2.17.5.tar.gz
  • Upload date:
  • Size: 174.8 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.5.tar.gz
Algorithm Hash digest
SHA256 61f98ec868f456b85f3a06ca1dc9051fa00b18c189210c54c72207108ce14f68
MD5 e4455f1e68349e06f639fbdc5c63d089
BLAKE2b-256 1b0df2d668e2f979a983f32233ebce1316d75f26501e444a415ee50e8772066d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.5-py3-none-win_amd64.whl
  • Upload date:
  • Size: 10.6 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.5-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 ab53e13fef6556e20daf8b1888bb6d4b8246dc9130e2e1d248febbf39fecf453
MD5 c7e59e4a8eb0f39782b33a1f2218fb86
BLAKE2b-256 7b12cfad0d93cddca851583dedd6caeb55ba77712b37f444d273f0396e35591b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.5-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.5-py3-none-win32.whl
Algorithm Hash digest
SHA256 fbfb264b6cd9f34335a88d0313542858f78c393b62865f48aa58522f72e5f88b
MD5 62001248286c4f6b4527141a065a3747
BLAKE2b-256 6012e2fd50a8b512f3c3e11960170b54ec228741fb4f542fd597ea55f18a5011

See more details on using hashes here.

File details

Details for the file sentry_cli-2.17.5-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.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 68ecde6ba5692616313b6de60e59aad72072700972200642e96dd652ef062ba0
MD5 7355ff7246f84d334a29cd89d5a33add
BLAKE2b-256 dfb3a89deb418f1397fa5fa96d894f734656a599d575fbe62d1a95005ecc0b3f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.5-py3-none-manylinux_2_17_i686.manylinux2014_i686.musllinux_1_2_i686.whl
Algorithm Hash digest
SHA256 73b1105a329f1fb143068112b186af6c9ba25532dc7e77648e0f6244f5f28638
MD5 e9c1b5b108a2ccb9bd126b835c32ecc6
BLAKE2b-256 607a519fb3d5de53bf81b1bc0658b189bd78e93fedb8129db8d21d4ded467463

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.5-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 63cbb1b24fc9ec2e899709edbe81f8a9f00b7d5b305f4d8faef1c196cabd82de
MD5 a905f577c232e35642f36d8b10b73700
BLAKE2b-256 0099893ff7e4bc4afc447301aac771c64f53397d8accb31972255283ff3d7602

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sentry_cli-2.17.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 a9db2644b7cc508b5963f4a95c76eb60f2f31cdc28db7226e368ed683e4859d4
MD5 360c80988852a995da4267371d3f5192
BLAKE2b-256 acf85025aba981c5984c2d5a21d6a87173776df5f0eaba1bb4bcec2f519608f6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.5-py3-none-macosx_11_0_universal2.whl
  • Upload date:
  • Size: 26.6 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.5-py3-none-macosx_11_0_universal2.whl
Algorithm Hash digest
SHA256 2195453ecdce8a6c410a269680ac0073673ae0889790f6f0502a2fceff8b967d
MD5 bfa5c3aef1fdf9f615fe021f97edba8a
BLAKE2b-256 803410878ff454b976c02decc9dc3f587ebd3a7155c0fe9b687be782347f4e1f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.5-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.5-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 60797cd6bccfa2d559fb7b179de48ed61e1d7ff421c9e8b4a34fd372f9af2505
MD5 88a37c3bdac6c10f3e4d776452f4b00f
BLAKE2b-256 672f5b27c541f215582f73fe0cf471f8a261ac83a02f39d58716536bc0b50ed5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sentry_cli-2.17.5-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.5-py3-none-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 26c4bea21239ba72a2726670954d37483982f3c535199dd8004f21c9cff9e76a
MD5 2b5f72b4d5ef876ddb8948933d379d9e
BLAKE2b-256 0435519f0d18cfaf7f8ef93bddc661e074500604107797fb8c965ca1a9610da5

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