@sentry/cli

What is @sentry/cli?

The @sentry/cli package is a command line interface tool that allows developers to interact with Sentry, a popular error tracking and monitoring tool. It provides functionalities for managing releases, uploading source maps, and configuring Sentry projects directly from the terminal.

What are @sentry/cli's main functionalities?

Creating new releases

This command creates a new release in Sentry. A release is a version of your code that is deployed to an environment.

sentry-cli releases new <release_name>

Uploading source maps

Source maps allow Sentry to de-minify your JavaScript code, which aids in debugging. This command uploads source maps for a specific release.

sentry-cli releases files <release_name> upload-sourcemaps /path/to/sourcemaps

Listing projects

This command lists all Sentry projects available to the user. It's useful for managing multiple projects or getting an overview of existing projects.

sentry-cli projects list

Other packages similar to @sentry/cli

bugsnag-sourcemaps

Similar to the source map upload feature of @sentry/cli, bugsnag-sourcemaps is a tool for uploading source maps to Bugsnag, another error tracking service. It provides a focused functionality compared to the broader scope of @sentry/cli.

rollbar-cli

rollbar-cli is a command line tool for interacting with Rollbar, an alternative to Sentry for error monitoring and reporting. It offers functionalities similar to @sentry/cli, such as managing releases and uploading source maps, tailored for Rollbar's platform.

README

Official Sentry Command Line Interface

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

Changelog

sentry-cli 1.32.3

• Skip invalid ZIP files during debug file upload (#320)
• Generate better error messages for renamed projects (#321)