adamjmcgrath / sentry-cli

A command line utility to work with Sentry.

Home Page:https://docs.sentry.io/hosted/learn/cli/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


Official Sentry Command Line Interface

Travis AppVeyor 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.

  • Binaries can be found under Releases
  • Documentation can be found here

Installation

The recommended way to install is with everybody's favorite curl to bash:

curl -sL https://sentry.io/get-cli/ | bash

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

Or homebrew:

brew install getsentry/tools/sentry-cli

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 -it -v $(pwd):/work getsentry/sentry-cli sentry-cli --help

Compiling

In case you want to compile this yourself, you need to install at minimum the following dependencies:

  • C and C++ 11 compiler
  • Make and CMake
  • OpenSSL 1.0.2j with development headers
  • Curl 7.50 with development headers
  • Rust 1.20 and Cargo

Use cargo to compile:

$ cargo build

In case you get OpenSSL errors you need to compile with the path to the OpenSSL headers. For instance:

$ CFLAGS=-I/usr/local/opt/openssl/include/ cargo build

Also, there is a Dockerfile that builds an Alpine-based Docker image with sentry-cli in the PATH. Note that this image is not minimal yet, as we are not able to compail against musl just yet. To build and use it, run:

docker build -t sentry-cli .
docker run --rm -it -v $(pwd):/work sentry-cli sentry-cli --help

About

A command line utility to work with Sentry.

https://docs.sentry.io/hosted/learn/cli/

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Rust 94.7%Language:JavaScript 2.6%Language:Shell 2.3%Language:Python 0.3%