Installations
npm install @sentry/cliDeveloper
Developer Guide
Module System
CommonJS
Min. Node Version
>= 10
Typescript Support
Yes
Node Version
20.18.1
NPM Version
10.8.2
Statistics
911 Stars
2,300 Commits
223 Forks
65 Watching
49 Branches
348 Contributors
Updated on 28 Nov 2024
Languages
Rust (93.05%)
JavaScript (5.5%)
Python (0.73%)
Shell (0.56%)
Dockerfile (0.11%)
Makefile (0.04%)
Java (0.01%)
Kotlin (0.01%)
Total Downloads
Cumulative downloads
Total Downloads
475,995,300
Last day
0.6%
845,855
Compared to previous day
Last week
3.1%
4,240,319
Compared to previous week
Last month
10.7%
17,941,990
Compared to previous month
Last year
45%
180,533,369
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
6
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.
Installation
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
pip
New in 2.14.3: sentry-cli can also be installed using pip:
1pip install sentry-cli
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>".
1npm install @sentry/cli --sentrycli_cdnurl=https://mymirror.local/path
Or add property into your .npmrc file (https://www.npmjs.org/doc/files/npmrc.html)
1sentrycli_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.
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:
1docker pull getsentry/sentry-cli 2docker 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:
1docker 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.
Update
To update sentry-cli to the latest version run:
1sentry-cli update
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
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:
1docker build -t sentry-cli . 2docker run --rm -v $(pwd):/work sentry-cli --help
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
30 commit(s) and 24 issue activity found in the last 90 days -- score normalized to 10
Reason
all changesets reviewed
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: BSD 3-Clause "New" or "Revised" License: LICENSE:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/getsentry/.github/SECURITY.md:1
- Info: Found linked content: github.com/getsentry/.github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/getsentry/.github/SECURITY.md:1
- Info: Found text in security policy: github.com/getsentry/.github/SECURITY.md:1
Reason
SAST tool is run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Info: all commits (30) are checked with a SAST tool
Reason
binaries present in source code
Details
- Warn: binary detected: tests/integration/_fixtures/Sentry.Samples.Console.Basic-embedded-ppdb-with-sources.dll:1
- Warn: binary detected: tests/integration/_fixtures/elf-Linux-ARMv7-ls:1
Reason
6 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: RUSTSEC-2021-0131
- Warn: Project is vulnerable to: RUSTSEC-2021-0141
- Warn: Project is vulnerable to: RUSTSEC-2021-0153
- Warn: Project is vulnerable to: RUSTSEC-2024-0384
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:151: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:153: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:158: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:171: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:203: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:204: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:207: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:212: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:218: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:229: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:230: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:233: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:260: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:271: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:92: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:100: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:116: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:139: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:181: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:188: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:192: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/ci.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/codeql-analysis.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-cli/release.yml/master?enable=pin
- Warn: containerImage not pinned by hash: Dockerfile:3
- Warn: containerImage not pinned by hash: Dockerfile:24: pin your Docker image by updating alpine:3.14 to alpine:3.14@sha256:0f2d5c38dd7a4f4f733e688e3a6733cb5ab1ac6e3cb4603a5dd564e5bfb80eed
- Warn: pipCommand not pinned by hash: .github/workflows/build.yml:192
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:80
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:83
- Info: 3 out of 34 GitHub-owned GitHubAction dependencies pinned
- Info: 8 out of 10 third-party GitHubAction dependencies pinned
- Info: 0 out of 2 containerImage dependencies pinned
- Info: 0 out of 1 pipCommand dependencies pinned
- Info: 0 out of 2 npmCommand dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/build.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact 2.38.2 not signed: https://api.github.com/repos/getsentry/sentry-cli/releases/183359709
- Warn: release artifact 2.38.1 not signed: https://api.github.com/repos/getsentry/sentry-cli/releases/182697405
- Warn: release artifact 2.38.0 not signed: https://api.github.com/repos/getsentry/sentry-cli/releases/181251441
- Warn: release artifact 2.37.0 not signed: https://api.github.com/repos/getsentry/sentry-cli/releases/178687888
- Warn: release artifact 2.36.6 not signed: https://api.github.com/repos/getsentry/sentry-cli/releases/178010363
- Warn: release artifact 2.38.2 does not have provenance: https://api.github.com/repos/getsentry/sentry-cli/releases/183359709
- Warn: release artifact 2.38.1 does not have provenance: https://api.github.com/repos/getsentry/sentry-cli/releases/182697405
- Warn: release artifact 2.38.0 does not have provenance: https://api.github.com/repos/getsentry/sentry-cli/releases/181251441
- Warn: release artifact 2.37.0 does not have provenance: https://api.github.com/repos/getsentry/sentry-cli/releases/178687888
- Warn: release artifact 2.36.6 does not have provenance: https://api.github.com/repos/getsentry/sentry-cli/releases/178010363
Score
6
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn MoreOther packages similar to @sentry/cli
@sentry/cli-linux-x64
The linux x64 distribution of the Sentry CLI binary.
@sentry/cli-darwin
The darwin distribution of the Sentry CLI binary.
@sentry/cli-linux-arm64
The linux arm64 distribution of the Sentry CLI binary.
@sentry/cli-linux-arm
The linux arm distribution of the Sentry CLI binary.