Skip to content
A command line utility to work with Sentry.
Rust JavaScript Other
Branch: master
Clone or download
mitsuhiko and jan-auer feat: Skip pch and large files in source bundles (#624)
This skips pch and large files in the source bundle writer.
Latest commit 7a083b4 Nov 29, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode feat: Ignore target/ in vscode (#471) Jan 29, 2019
azure-pipelines ci: Build on Azure Pipelines (#499) Mar 20, 2019
bin ref(js): Use ES6 language level (#235) Feb 1, 2018
js fix(js): Fix validation of set-commits options (#618) Nov 6, 2019
scripts feat: Support Brotli, GZip, Deflate (#607) Oct 8, 2019
src feat: Skip pch and large files in source bundles (#624) Nov 29, 2019
.appveyor.yml ci: Fix PR builds from forks (#426) Nov 13, 2018
.craft.yml build: Update Craft config (checksums, required files) (#574) Jul 26, 2019
.dockerignore fix(docker): Add a warning about the new entrypoint (#367) Aug 30, 2018
.editorconfig ref(js): Use ES6 language level (#235) Feb 1, 2018
.eslintrc meta: ignore class-methods-use-this generally Mar 9, 2018
.gitignore ref: Use release registry for update checks (#438) Dec 6, 2018
.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 fix(bug): Using annotated tags now returns the correct commit SHA (#598) Sep 22, 2019
CHANGELOG.md meta: Changelog for 1.49.0 Nov 6, 2019
Cargo.lock feat: Skip pch and large files in source bundles (#624) Nov 29, 2019
Cargo.toml feat: Skip pch and large files in source bundles (#624) Nov 29, 2019
Dockerfile fix(docker): Add a warning about the new entrypoint (#367) Aug 30, 2018
LICENSE Changed URL to sentry.io Aug 30, 2016
Makefile feat: Add RAM bundle support (iOS) (#523) May 6, 2019
README.md fix: Use travis.com links Feb 6, 2019
azure-pipelines.yml ci: Build on Azure Pipelines (#499) Mar 20, 2019
build.rs ref: Fix all clippy lints Sep 17, 2018
docker-entrypoint.sh ref(docker): Remove warning from the entrypoint Sep 20, 2019
package.json release: 1.49.0 Nov 6, 2019
yarn.lock fix: Fix progress bar calculations (#606) Oct 8, 2019

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

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
  • 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. To build and use it, run:

docker build -t sentry-cli .
docker run --rm -v $(pwd):/work sentry-cli --help
You can’t perform that action at this time.