A command line utility to work with Sentry.
Rust JavaScript Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github feat: Use "craft" for releasing (#343) Jul 17, 2018
.vscode feat: Streamline js api with cli (#208) Jan 10, 2018
bin ref(js): Use ES6 language level (#235) Feb 1, 2018
docs Link to repository configuration (#347) Jul 26, 2018
js meta: ignore class-methods-use-this generally Mar 9, 2018
scripts feat: Use "craft" for releasing (#343) Jul 17, 2018
src fix: Safely reset handles only if the config managed to initialize (#355 Aug 14, 2018
.craft.yml meta: Update changelog policy for craft Aug 17, 2018
.dockerignore build: Add a preliminary Dockerfile to build on Alpine Nov 20, 2017
.editorconfig ref(js): Use ES6 language level (#235) Feb 1, 2018
.eslintrc meta: ignore class-methods-use-this generally Mar 9, 2018
.gitignore feat: Add SentryCli js interface Dec 6, 2017
.npmignore ref(npm): Add support for proxies in the NPM installer (#230) Jan 30, 2018
.prettierrc ref(event): Use sentry to send events (#316) Jun 4, 2018
.travis.yml feat: Use "craft" for releasing (#343) Jul 17, 2018
CHANGELOG.md meta: Update changelog policy for craft Aug 17, 2018
Cargo.lock release: 1.35.1 Aug 17, 2018
Cargo.toml release: 1.35.1 Aug 17, 2018
Dockerfile ci: Refactor and optimize Linux CI builds (#294) May 3, 2018
LICENSE Changed URL to sentry.io Aug 30, 2016
README.md ref(npm): Add support for proxies in the NPM installer (#230) Jan 30, 2018
appveyor.yml feat: Use "craft" for releasing (#343) Jul 17, 2018
build.rs feat: Converted sentry-cli to failure and add sentry support (#288) Apr 25, 2018
package.json release: 1.35.1 Aug 17, 2018
yarn.lock ref(event): Use sentry to send events (#316) Jun 4, 2018

README.md


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.

  • Downloads 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

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 releases. This should work fine for most people. If you are experiencing issues with downloading from GitHub, you may need to use a different download mirror. 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 -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:

  • Rust 1.23 and Cargo
  • Make, CMake and a C compiler
  • OpenSSL 1.0.2n with development headers
  • Curl 7.50 with development headers

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