@sentry/cli
Advanced tools
A command line utility to work with Sentry. https://docs.sentry.io/hosted/learn/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.
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/sourcemapsListing 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 listSimilar 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 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.
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.
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.33.1 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
New in 2.14.3: sentry-cli can also be installed using pip:
pip install sentry-cli
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
There are a few environment variables that you can provide to control the npm installation:
SENTRYCLI_CDNURL=<url> # Use alternative cdn url for downloading binary
SENTRYCLI_USE_LOCAL=1 # Use local instance of sentry-cli binary (looked up via $PATH environment)
SENTRYCLI_SKIP_DOWNLOAD=1 # Skip downloading binary entirely
SENTRYCLI_NO_PROGRESS_BAR=1 # Do not print the progress bar when downloading binary (default for non-TTY environments like CI)
SENTRYCLI_LOG_STREAM=<stdout|stderr> # Changes where to redirect install script output
When using sentry-cli via JavaScript API or any 3rd party plugin that is consuming said API,
you can also use SENTRY_BINARY_PATH=<path> alongside SENTRYCLI_SKIP_DOWNLOAD=1 to completely
control what binaries are downloaded and used throughout the whole process.
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.
A homebrew recipe is provided in the getsentry/tools tap:
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 -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.
To update sentry-cli to the latest version run:
sentry-cli update
In case you want to compile this yourself, you need to install at minimum the following dependencies:
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
2.40.0
globalThis when available (#2301) by @lforstWe made several refactors and added several tests in this release. These changes should not affect users.
upload-dif reference from poll_assemble (#2321) by @szokeasaurusrexrender_detail take Option<&str> (#2317) by @szokeasaurusrexupload_difs_chunked (#2316) by @szokeasaurusrexupload module to options (#2315) by @szokeasaurusrexChunkOptions a struct (#2314) by @szokeasaurusrex&str in DifUpload struct (#2307) by @szokeasaurusrexpoll_assemble (#2300) by @szokeasaurusrex/ to uploaded Proguard file name (#2304) by @szokeasaurusrextry_assemble options parameter (#2299) by @szokeasaurusrexChunkedUploadOptions to indicate they are set by server (#2298) by @szokeasaurusrexChunked<ProguardMapping> for proguard upload (#2296) by @szokeasaurusrexChunkedDifRequest take Cow<'_, str> for name (#2295) by @szokeasaurusrexMappingRef with ProguardMapping (#2294) by @szokeasaurusrexproguard utils submodule (#2293) by @szokeasaurusrexByteView (#2292) by @szokeasaurusrexChunkedDifRequest (#2290) by @szokeasaurusrexNamed trait to Assemblable (#2289) by @szokeasaurusrexpoll_assemble generic (#2287) by @szokeasaurusrexToAssemble traittry_assemble_dif genericChunkedDifMatch with generic ChunkedObjectusize in get_sha1_checksums signatureassert_cmd test managerFAQs
A command line utility to work with Sentry. https://docs.sentry.io/hosted/learn/cli/
We found that @sentry/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.