getsentry/sentry-cli

官方Sentry命令行界面

概述

Sentry命令行界面（sentry-cli）是Sentry的官方命令行客户端，用于执行各类通用任务，目前主要用于在不使用Fastlane工具时向Sentry上传调试符号。可从https://github.com/getsentry/sentry-cli/releases/%E8%8E%B7%E5%8F%96%E4%B8%8B%E8%BD%BD%EF%BC%8C%E8%AF%A6%E7%BB%86%E6%96%87%E6%A1%A3%E5%8F%82%E8%A7%81Sentry%E5%AE%98%E6%96%B9%E6%96%87%E6%A1%A3%E3%80%82

核心功能与特性

• 向Sentry上传调试符号，支持错误跟踪与调试
• 跨平台支持（OS X、Linux、Windows）
• 多种安装方式，适配不同开发环境
• 支持自定义安装源（如自定义CDN）和版本控制
• 提供JavaScript API及第三方插件集成能力

使用场景

• 开发流程中与Sentry集成，上传应用调试符号
• CI/CD环境中自动化Sentry相关任务，确保构建可重现
• 不使用Fastlane工具时的调试符号管理
• 需要跨平台、多环境统一的Sentry命令行工具支持

安装与使用方法

curl安装（OS X/Linux）

通过自动化下载器获取最新版本并安装：

bash
curl -sL https://sentry.io/get-cli/ | bash

指定版本安装

为确保构建可重现，建议固定版本：

bash
curl -sL https://sentry.io/get-cli/ | SENTRY_CLI_VERSION=2.33.1 bash

自定义安装目录

设置INSTALL_DIR环境变量指定安装路径（适用于无sudo权限或自定义位置）：

bash
export INSTALL_DIR=/custom/installation/path
curl -sL https://sentry.io/get-cli/ | bash

验证安装

安装后通过帮助命令验证：

bash
sentry-cli --help

注意：Windows环境需安装Microsoft Visual C++ Redistributable。

pip安装

2.14.3及以上版本支持通过pip安装：

bash
pip install sentry-cli

Node/npm安装

通过npm安装：

bash
npm install @sentry/cli

全局安装

全局安装需确保node_modules目录权限正确，或使用管理员权限：

bash
sudo npm install -g @sentry/cli --unsafe-perm

自定义CDN

默认从Fastly CDN下载，可通过npm配置或环境变量指定自定义CDN：

bash
npm install @sentry/cli --sentrycli_cdnurl=https://mymirror.local/path

或在.npmrc中添加：

rc
sentrycli_cdnurl=https://mymirror.local/path

环境变量控制

• SENTRYCLI_CDNURL：指定二进制下载CDN地址
• SENTRYCLI_USE_LOCAL=1：使用本地sentry-cli（通过$PATH查找）
• SENTRYCLI_SKIP_DOWNLOAD=1：跳过二进制下载
• SENTRYCLI_NO_PROGRESS_BAR=1：禁用下载进度条（非TTY环境默认禁用）
• SENTRYCLI_LOG_STREAM=<stdout|stderr>：指定安装脚本输出流
• SENTRY_BINARY_PATH=<path>：配合SENTRYCLI_SKIP_DOWNLOAD=1指定二进制路径

代理支持：通过npm配置的HTTPS代理或HTTPS_PROXY环境变量支持代理环境。

Homebrew安装

通过getsentry/tools tap安装：

bash
brew install getsentry/tools/sentry-cli

Docker使用

1.25.0及以上版本提供官方Docker镜像，包含预安装的sentry-cli。推荐生产环境使用latest标签，开发环境可使用edge标签：

拉取镜像

bash
docker pull getsentry/sentry-cli

基本使用

bash
docker run --rm -v $(pwd):/work getsentry/sentry-cli --help

2.8.0+版本注意事项

若出现"error: config value 'safe.directory' was not found;"错误，需正确设置挂载卷的UID和GID：

bash
docker run --rm -u "$(id -u):$(id -g)" -v $(pwd):/work getsentry/sentry-cli --help

（此为旧版git安全问题导致，详情参见GitHub安全公告）

更新

更新至最新版本：

bash
sentry-cli update

编译

如需自行编译，需安装以下依赖：

• Rust stable及Cargo
• Make、CMake及C编译器

编译步骤

使用Cargo编译：

bash
cargo build

Docker镜像编译

项目包含Dockerfile，可构建基于Alpine的镜像：

bash
docker build -t sentry-cli .
docker run --rm -v $(pwd):/work sentry-cli --help