sentry-cli

用途

Sentry CLI 使用指南，介绍如何通过命令行与 Sentry 交互。适用于用户询问查看问题（issues）、事件、项目、组织，发起 API 调用，或通过 CLI 进行身份验证等场景。

主要能力

• 身份验证管理：sentry auth login、logout、refresh、status、token、whoami。
• 组织与项目：sentry org list、org view；sentry project create/delete/list/view。
• 问题管理：sentry issue list/events/explain/plan/view/resolve/unresolve/archive/merge，其中 explain 与 plan 使用 Seer AI 进行根因分析与生成解决方案计划。
• 事件：sentry event view/list。
• API 访问：sentry api <endpoint>，提供类似 curl 的接口（--method、--data、--header），自动处理身份验证。
• CLI 工具：sentry cli defaults/feedback/fix/setup/upgrade。
• 仪表盘：sentry dashboard list/view/create 及 dashboard widget add/edit/delete、dashboard revisions/restore。
• 会话回放：sentry replay list/view。
• 发布版本：sentry release list/view/create 等。

使用方式

前置条件

CLI 必须先安装并认证。

安装：

curl https://cli.sentry.dev/install -fsS | bash
curl https://cli.sentry.dev/install -fsS | bash -s -- --version nightly

# 或通过 npm/pnpm/bun 安装
npm install -g sentry

认证：

sentry auth login
sentry auth login --token YOUR_SENTRY_API_TOKEN
sentry auth status
sentry auth logout

设计约定

<名词> <动词> 命令模式，标志遵循 gh 约定：--json 输出机器可读格式、--fields 选择特定字段、-w/--web 在浏览器打开、-q/--query 过滤、-n/--limit 限制结果数量。sentry api 模仿 curl。

工作流模式

排查问题：

sentry issue list --query "is:unresolved" --limit 5
sentry issue view PROJECT-123
sentry issue explain PROJECT-123
sentry issue plan PROJECT-123

浏览追踪与性能：

sentry trace list --limit 5
sentry trace view abc123def456...
sentry span list abc123def456...
sentry trace logs abc123def456...

流式日志：

sentry log list --follow
sentry log list --query "severity:error"

探索 API Schema：

sentry schema
sentry schema issues
sentry schema "GET /api/0/organizations/{organization_id_or_slug}/issues/"

管理发布：

sentry release create my-org/1.0.0 --project my-project
sentry release set-commits my-org/1.0.0 --auto
sentry release set-commits my-org/1.0.0 --local
sentry release finalize my-org/1.0.0
sentry release deploy my-org/1.0.0 production

任意 API 访问：

sentry api /api/0/organizations/my-org/
sentry api /api/0/organizations/my-org/projects/ --method POST --data '{"name":"new-project","platform":"python"}'

退出码

0 成功；10–19 认证错误；20–29 输入错误；30–39 API 错误；40–49 功能不可用；50–59 操作错误；60–69 命令特定错误。

适用场景

• 通过命令行查看和管理 Sentry 的问题、事件、项目与组织。
• 排查特定 issue 并获得 AI 根因分析与修复计划。
• 查看追踪（traces）、span 树与关联日志。
• 实时流式查看日志。
• 管理发布版本及关联提交、记录部署。
• 构建与管理 Sentry 仪表盘及组件。
• 检索会话回放。
• 对未被专用命令覆盖的端点发起任意 API 请求。

限制与注意

• 必须先安装并认证，缺失或过期认证时 CLI 会提示。
• 破坏性命令（project delete、trial start）执行前需与用户确认。
• 不得存储或记录认证令牌，CLI 自动管理凭据。
• 问题 ID 应使用短 ID（如 PROJECT-123），而非数字 ID。
• 程序化处理输出时应使用 --json。
• --query 使用 Sentry 搜索语法而非自由文本。
• 发布版本的 org/version 中 org/ 属于组织而非版本号的一部分，版本须与 Sentry.init() 中的 release 值一致。
• set-commits --auto 需要 Sentry 仓库集成与本地 git 检出；无检出时使用 --local。
• 仪表盘使用 6 列网格，组件宽度之和应为 6 以填满整行。

暂未提供

该资料未提供 Sentry CLI 的收费、价格、平台分布或效果数据。