• Stars
    star
    833
  • Rank 54,737 (Top 2 %)
  • Language
    Rust
  • License
    BSD 3-Clause "New...
  • Created almost 9 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A command line utility to work with Sentry.

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

More Repositories

1

sentry

Developer-first error tracking and performance monitoring
Python
38,989
star
2

sentry-javascript

Official Sentry SDKs for JavaScript
TypeScript
7,952
star
3

self-hosted

Sentry, feature-complete and packaged up for low-volume deployments and proofs-of-concept
Shell
7,663
star
4

responses

A utility for mocking out the Python Requests library.
Python
4,127
star
5

sentry-php

The official PHP SDK for Sentry (sentry.io)
PHP
1,817
star
6

raven-python

Raven is the legacy Python client for Sentry (getsentry.com) β€” replaced by sentry-python
Python
1,678
star
7

sentry-react-native

Official Sentry SDK for React Native
TypeScript
1,566
star
8

sentry-python

The official Python SDK for Sentry.io
Python
1,533
star
9

sentry-laravel

The official Laravel SDK for Sentry (sentry.io)
PHP
1,157
star
10

sentry-java

A Sentry SDK for Java, Android and other JVM languages.
Kotlin
1,154
star
11

sentry-ruby

Sentry SDK for Ruby
Ruby
927
star
12

sentry-go

The official Go SDK for Sentry (sentry.io)
Go
917
star
13

sentry-cocoa

The official Sentry SDK for iOS, tvOS, macOS, watchOS.
Objective-C
803
star
14

milksnake

A setuptools/wheel/cffi extension to embed a binary data in wheels
Python
764
star
15

sentry-symfony

The official Symfony SDK for Sentry (sentry.io)
PHP
687
star
16

sentry-webpack-plugin

Repo moved to https://github.com/getsentry/sentry-javascript-bundler-plugins. Please open any issues/PRs there.
JavaScript
662
star
17

freight

Freight is a service which aims to make application deployments better.
Python
610
star
18

sentry-elixir

The official Elixir SDK for Sentry (sentry.io)
Elixir
597
star
19

sentry-dotnet

Sentry SDK for .NET
C#
576
star
20

raven-go

Sentry client in Go
Go
560
star
21

sentry-rust

Official Sentry SDK for Rust
Rust
515
star
22

raven-node

A standalone (Node.js) client for Sentry
JavaScript
457
star
23

symbolic

Stack trace symbolication library written in Rust
Rust
440
star
24

action-release

GitHub Action for creating a release on Sentry
TypeScript
424
star
25

sentry-kubernetes

Kubernetes event reporter for Sentry
Python
408
star
26

sentry-native

Sentry SDK for C, C++ and native applications.
C
397
star
27

pdb

A parser for Microsoft PDB (Program Database) debugging information
Rust
385
star
28

symbolicator

Native Symbolication as a Service
Rust
357
star
29

spotlight

Your Universal Debug Toolbar
TypeScript
356
star
30

docker-sentry

Docker Official Image packaging for Sentry
Python
348
star
31

sentry-docs

Sentry's documentation (and tools to build it)
MDX
331
star
32

rb

Routing and connection management for Redis in Python
Python
300
star
33

sentry-php-sdk

This is a meta package to ship sentry-php with a recommend http client.
298
star
34

snuba

Search the seas for your lost treasure.
Python
272
star
35

relay

Sentry event forwarding and ingestion service.
Rust
246
star
36

raven-csharp

Superseded by: https://github.com/getsentry/sentry-dotnet
C#
232
star
37

sentry-electron

The official Sentry SDK for Electron
TypeScript
217
star
38

sentry-plugins

Official plugins for Sentry server
Python
212
star
39

zeus

WIP: A dashboard for CI
Python
209
star
40

sentry-unity

Development of Sentry SDK for Unity
C#
208
star
41

sentry-wizard

Sentry Project Setup Wizard
TypeScript
192
star
42

rust-sourcemap

A library for rust that implements basic sourcemap handling
Rust
188
star
43

action-github-app-token

Gets a GitHub auth token for a GitHub App installation
TypeScript
184
star
44

sentry-android-gradle-plugin

Gradle plugin for Sentry Android. Upload proguard, debug files, and more.
Kotlin
142
star
45

sentry-fastlane-plugin

Official fastlane plugin for Sentry
Ruby
136
star
46

sentry-slack

DEPRECATED Slack integration for Sentry
Python
135
star
47

sentry-javascript-bundler-plugins

JavaScript Bundler Plugins for Sentry
TypeScript
133
star
48

action-git-diff-suggestions

This GitHub Action will take the current git changes and apply them as GitHub code review suggestions
TypeScript
122
star
49

examples

Collection of all different kinds of Sentry SDKs and integrations
C#
119
star
50

craft

The universal Sentry release CLI πŸš€
TypeScript
118
star
51

sentry-capacitor

The official Sentry SDK for Capacitor
TypeScript
117
star
52

sentry-kotlin-multiplatform

Sentry SDK for Kotlin Multiplatform
Kotlin
104
star
53

sentry-clj

Sentry SDK for Clojure
Clojure
103
star
54

raven-objc

This SDK is deprecated. Use https://github.com/getsentry/sentry-cocoa
Objective-C
98
star
55

sentry-jira

A Plugin for sentry that lets you create JIRA issues
Python
95
star
56

raven-aiohttp

An aiohttp transport for raven-python
Python
90
star
57

sentry-android

MOVED: https://github.com/getsentry/sentry-java
87
star
58

sentry-unreal

Unreal Engine
C++
84
star
59

pytest-responses

py.test integration for responses
Python
83
star
60

sentry-github

A Sentry extension which integrates with GitHub.
Python
79
star
61

libsourcemap

DEPRECATED: Implements efficient sourcemap processing for Python in Rust
Rust
78
star
62

sentry-rrweb

Moved to: https://github.com/getsentry/sentry-javascript/tree/master/packages/replay#sentry-session-replay
TypeScript
73
star
63

sentry-cordova

The official Sentry SDK for Cordova
TypeScript
68
star
64

sentry-dart-plugin

A Dart Build Plugin that uploads debug symbols for Android, iOS/macOS and source maps for Web to Sentry via sentry-cli
Dart
66
star
65

sourcemaps.io

Web-based Source Map validator
TypeScript
58
star
66

breakpad-tools

Prebuilt tools and examples to work with Breakpad's minidumps
Makefile
56
star
67

dotnet-assembly-alias

Tool to rename .NET assemblies and references
C#
53
star
68

sentry-webhooks

An extension for Sentry which allows creation various web hooks.
Python
52
star
69

sentry-netlify-build-plugin

The Sentry Netlify build plugin automatically notifies Sentry of new releases being deployed to your site.
JavaScript
46
star
70

sentry-mobile-release-health-app

Sentry Mobile App
Dart
44
star
71

sentry-xamarin

Sentry for Xamarin Native and Xamarin.Forms
C#
44
star
72

develop

TypeScript
43
star
73

babel-gettext-extractor

A fork of babel-gettext-plugin that works with older versions of node and supports comment and location extraction
JavaScript
43
star
74

raven-swift

This SDK is deprecated. Use https://github.com/getsentry/sentry-cocoa
40
star
75

pytest-sentry

Track flaky tests in Sentry
Python
39
star
76

sentry-auth-github

GitHub SSO provider for Sentry
Python
39
star
77

arroyo

A library to build streaming applications that consume from and produce to Kafka.
Python
39
star
78

action-visual-snapshot

Save and compare your visual snapshots
TypeScript
38
star
79

sentry-fullstory

The Sentry-FullStory integration seamlessly integrates the Sentry and FullStory platforms.
TypeScript
37
star
80

sentry-phabricator

A Sentry extension which integrates with Phabricator
Python
36
star
81

platformicons

A platform and framework icon font.
TypeScript
36
star
82

sentry-auth-google

Google Apps SSO provider for Sentry
Python
34
star
83

integration-platform-example

An example kanban application which explores the ways developers can build apps on Sentry's integration platform
TypeScript
32
star
84

unity

Unity SDK UPM package
Objective-C
31
star
85

vanguard

TypeScript
29
star
86

profiling-node

The code for this repo now lives in https://github.com/getsentry/sentry-javascript/tree/develop/packages/profiling-node
TypeScript
29
star
87

symbol-collector

Clients and Server to collect system symbols.
C#
29
star
88

sentry-vscode

VSCode editor integration for Sentry
TypeScript
28
star
89

probot-report

Probot app that sends periodic reminder emails for outstanding PR reviews
JavaScript
28
star
90

hackweek-coda

A queue thing with a sprinkle of Italian
Python
27
star
91

sentry-replay

Moved to http://github.com/getsentry/sentry-javascript
TypeScript
27
star
92

perl-raven

A perl sentry client
Perl
26
star
93

sentry_airflow

Airflow integration with Sentry (https://sentry.io)
Python
26
star
94

cloud-run-typescript-template

Template for Google Cloud Run (typescript)
JavaScript
24
star
95

symsynd

C++
23
star
96

sentry-relay-attic

A relay server for Sentry (https://getsentry.com)
Rust
23
star
97

freight-cli

A command line interface to Freight
Python
22
star
98

xds

xDS service for Envoy
Go
22
star
99

atlas

A map to your company
Python
22
star
100

gib-potato

More Potato, more awesome πŸ₯”
PHP
21
star