Skip to content

Commit 5ebb35e

Browse files
committed
Deploy preview for PR 662 🛫
1 parent d43da07 commit 5ebb35e

File tree

109 files changed

+12122
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+12122
-0
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"skills": [
3+
{
4+
"name": "sentry-cli",
5+
"description": "Guide for using the Sentry CLI to interact with Sentry from the command line. Use when the user asks about viewing issues, events, projects, organizations, making API calls, or authenticating with Sentry via CLI.",
6+
"files": [
7+
"SKILL.md",
8+
"references/api.md",
9+
"references/auth.md",
10+
"references/dashboards.md",
11+
"references/events.md",
12+
"references/issues.md",
13+
"references/logs.md",
14+
"references/organizations.md",
15+
"references/projects.md",
16+
"references/release.md",
17+
"references/setup.md",
18+
"references/sourcemap.md",
19+
"references/teams.md",
20+
"references/traces.md",
21+
"references/trials.md"
22+
]
23+
}
24+
]
25+
}

‎pr-preview/pr-662/.well-known/skills/sentry-cli/SKILL.md‎

Lines changed: 463 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
name: sentry-cli-api
3+
version: 0.25.0-dev.0
4+
description: Make arbitrary Sentry API requests
5+
requires:
6+
bins: ["sentry"]
7+
auth: true
8+
---
9+
10+
# API Command
11+
12+
Make an authenticated API request
13+
14+
### `sentry api <endpoint>`
15+
16+
Make an authenticated API request
17+
18+
**Flags:**
19+
- `-X, --method <value> - The HTTP method for the request - (default: "GET")`
20+
- `-d, --data <value> - Inline JSON body for the request (like curl -d)`
21+
- `-F, --field <value>... - Add a typed parameter (key=value, key[sub]=value, key[]=value)`
22+
- `-f, --raw-field <value>... - Add a string parameter without JSON parsing`
23+
- `-H, --header <value>... - Add a HTTP request header in key:value format`
24+
- `--input <value> - The file to use as body for the HTTP request (use "-" to read from standard input)`
25+
- `--silent - Do not print the response body`
26+
- `--verbose - Include full HTTP request and response in the output`
27+
- `-n, --dry-run - Show the resolved request without sending it`
28+
29+
**Examples:**
30+
31+
```bash
32+
# List organizations
33+
sentry api organizations/
34+
35+
# Get a specific issue
36+
sentry api issues/123456789/
37+
38+
# Create a release
39+
sentry api organizations/my-org/releases/ \
40+
-X POST -F version=1.0.0
41+
42+
# With inline JSON body
43+
sentry api issues/123456789/ \
44+
-X POST -d '{"status": "resolved"}'
45+
46+
# Update an issue status
47+
sentry api issues/123456789/ \
48+
-X PUT -F status=resolved
49+
50+
# Assign an issue
51+
sentry api issues/123456789/ \
52+
-X PUT --field assignedTo="user@example.com"
53+
54+
sentry api projects/my-org/my-project/ -X DELETE
55+
56+
# Add custom headers
57+
sentry api organizations/ -H "X-Custom: value"
58+
59+
# Read body from a file
60+
sentry api projects/my-org/my-project/releases/ -X POST --input release.json
61+
62+
# Verbose mode (shows full HTTP request/response)
63+
sentry api organizations/ --verbose
64+
65+
# Preview the request without sending
66+
sentry api organizations/ --dry-run
67+
```
68+
69+
All commands also support `--json`, `--fields`, `--help`, `--log-level`, and `--verbose` flags.
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
name: sentry-cli-auth
3+
version: 0.25.0-dev.0
4+
description: Authenticate with Sentry via OAuth or API tokens
5+
requires:
6+
bins: ["sentry"]
7+
auth: true
8+
---
9+
10+
# Authentication Commands
11+
12+
Authenticate with Sentry
13+
14+
### `sentry auth login`
15+
16+
Authenticate with Sentry
17+
18+
**Flags:**
19+
- `--token <value> - Authenticate using an API token instead of OAuth`
20+
- `--timeout <value> - Timeout for OAuth flow in seconds (default: 900) - (default: "900")`
21+
- `--force - Re-authenticate without prompting`
22+
23+
**Examples:**
24+
25+
```bash
26+
sentry auth login
27+
28+
sentry auth login --token YOUR_SENTRY_API_TOKEN
29+
30+
SENTRY_URL=https://sentry.example.com sentry auth login
31+
32+
SENTRY_URL=https://sentry.example.com sentry auth login --token YOUR_TOKEN
33+
```
34+
35+
### `sentry auth logout`
36+
37+
Log out of Sentry
38+
39+
**Examples:**
40+
41+
```bash
42+
sentry auth logout
43+
```
44+
45+
### `sentry auth refresh`
46+
47+
Refresh your authentication token
48+
49+
**Flags:**
50+
- `--force - Force refresh even if token is still valid`
51+
52+
**Examples:**
53+
54+
```bash
55+
sentry auth refresh
56+
```
57+
58+
### `sentry auth status`
59+
60+
View authentication status
61+
62+
**Flags:**
63+
- `--show-token - Show the stored token (masked by default)`
64+
- `-f, --fresh - Bypass cache, re-detect projects, and fetch fresh data`
65+
66+
**Examples:**
67+
68+
```bash
69+
sentry auth status
70+
71+
# Show the raw token
72+
sentry auth status --show-token
73+
74+
# View current user
75+
sentry auth whoami
76+
```
77+
78+
### `sentry auth token`
79+
80+
Print the stored authentication token
81+
82+
**Examples:**
83+
84+
```bash
85+
sentry auth token
86+
```
87+
88+
### `sentry auth whoami`
89+
90+
Show the currently authenticated user
91+
92+
**Flags:**
93+
- `-f, --fresh - Bypass cache, re-detect projects, and fetch fresh data`
94+
95+
All commands also support `--json`, `--fields`, `--help`, `--log-level`, and `--verbose` flags.
Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
---
2+
name: sentry-cli-dashboards
3+
version: 0.25.0-dev.0
4+
description: List, view, and create Sentry dashboards
5+
requires:
6+
bins: ["sentry"]
7+
auth: true
8+
---
9+
10+
# Dashboard Commands
11+
12+
Manage Sentry dashboards
13+
14+
### `sentry dashboard list <org/title-filter...>`
15+
16+
List dashboards
17+
18+
**Flags:**
19+
- `-w, --web - Open in browser`
20+
- `-n, --limit <value> - Maximum number of dashboards to list - (default: "30")`
21+
- `-f, --fresh - Bypass cache, re-detect projects, and fetch fresh data`
22+
- `-c, --cursor <value> - Navigate pages: "next", "prev", "first" (or raw cursor string)`
23+
24+
**Examples:**
25+
26+
```bash
27+
# List all dashboards
28+
sentry dashboard list
29+
30+
# Filter by name pattern
31+
sentry dashboard list "Backend*"
32+
33+
# Open dashboard list in browser
34+
sentry dashboard list -w
35+
```
36+
37+
### `sentry dashboard view <org/project/dashboard...>`
38+
39+
View a dashboard
40+
41+
**Flags:**
42+
- `-w, --web - Open in browser`
43+
- `-f, --fresh - Bypass cache, re-detect projects, and fetch fresh data`
44+
- `-r, --refresh <value> - Auto-refresh interval in seconds (default: 60, min: 10)`
45+
- `-t, --period <value> - Time period override (e.g., "24h", "7d", "14d")`
46+
47+
**Examples:**
48+
49+
```bash
50+
# View by title
51+
sentry dashboard view 'Frontend Performance'
52+
53+
# View by ID
54+
sentry dashboard view 12345
55+
56+
# Auto-refresh every 30 seconds
57+
sentry dashboard view "Backend Performance" --refresh 30
58+
59+
# Open in browser
60+
sentry dashboard view 12345 -w
61+
```
62+
63+
### `sentry dashboard create <org/project/title...>`
64+
65+
Create a dashboard
66+
67+
**Examples:**
68+
69+
```bash
70+
sentry dashboard create 'Frontend Performance'
71+
```
72+
73+
### `sentry dashboard widget add <org/project/dashboard/title...>`
74+
75+
Add a widget to a dashboard
76+
77+
**Flags:**
78+
- `-d, --display <value> - Display type (big_number, line, area, bar, table, stacked_area, top_n, text, categorical_bar, details, wheel, rage_and_dead_clicks, server_tree, agents_traces_table)`
79+
- `--dataset <value> - Widget dataset (default: spans)`
80+
- `-q, --query <value>... - Aggregate expression (e.g. count, p95:span.duration)`
81+
- `-w, --where <value> - Search conditions filter (e.g. is:unresolved)`
82+
- `-g, --group-by <value>... - Group-by column (repeatable)`
83+
- `-s, --sort <value> - Order by (prefix - for desc, e.g. -count)`
84+
- `-n, --limit <value> - Result limit`
85+
- `--x <value> - Grid column position (0-based, 0–5)`
86+
- `--y <value> - Grid row position (0-based)`
87+
- `--width <value> - Widget width in grid columns (1–6)`
88+
- `--height <value> - Widget height in grid rows (min 1)`
89+
90+
**Examples:**
91+
92+
```bash
93+
# Simple counter widget
94+
sentry dashboard widget add 'My Dashboard' "Error Count" \
95+
--display big_number --query count
96+
97+
# Line chart with group-by
98+
sentry dashboard widget add 'My Dashboard' "Errors by Browser" \
99+
--display line --query count --group-by browser.name
100+
101+
# Table with multiple aggregates, sorted descending
102+
sentry dashboard widget add 'My Dashboard' "Top Endpoints" \
103+
--display table \
104+
--query count --query p95:span.duration \
105+
--group-by transaction \
106+
--sort -count --limit 10
107+
108+
# With search filter
109+
sentry dashboard widget add 'My Dashboard' "Slow Requests" \
110+
--display bar --query p95:span.duration \
111+
--where "span.op:http.client" \
112+
--group-by span.description
113+
```
114+
115+
### `sentry dashboard widget edit <org/project/dashboard...>`
116+
117+
Edit a widget in a dashboard
118+
119+
**Flags:**
120+
- `-i, --index <value> - Widget index (0-based)`
121+
- `-t, --title <value> - Widget title to match`
122+
- `--new-title <value> - New widget title`
123+
- `-d, --display <value> - Display type (big_number, line, area, bar, table, stacked_area, top_n, text, categorical_bar, details, wheel, rage_and_dead_clicks, server_tree, agents_traces_table)`
124+
- `--dataset <value> - Widget dataset (default: spans)`
125+
- `-q, --query <value>... - Aggregate expression (e.g. count, p95:span.duration)`
126+
- `-w, --where <value> - Search conditions filter (e.g. is:unresolved)`
127+
- `-g, --group-by <value>... - Group-by column (repeatable)`
128+
- `-s, --sort <value> - Order by (prefix - for desc, e.g. -count)`
129+
- `-n, --limit <value> - Result limit`
130+
- `--x <value> - Grid column position (0-based, 0–5)`
131+
- `--y <value> - Grid row position (0-based)`
132+
- `--width <value> - Widget width in grid columns (1–6)`
133+
- `--height <value> - Widget height in grid rows (min 1)`
134+
135+
**Examples:**
136+
137+
```bash
138+
# Change display type
139+
sentry dashboard widget edit 12345 --title 'Error Count' --display bar
140+
141+
# Rename a widget
142+
sentry dashboard widget edit 'My Dashboard' --index 0 --new-title 'Total Errors'
143+
144+
# Change the query
145+
sentry dashboard widget edit 12345 --title 'Error Rate' --query p95:span.duration
146+
```
147+
148+
### `sentry dashboard widget delete <org/project/dashboard...>`
149+
150+
Delete a widget from a dashboard
151+
152+
**Flags:**
153+
- `-i, --index <value> - Widget index (0-based)`
154+
- `-t, --title <value> - Widget title to match`
155+
- `-y, --yes - Skip confirmation prompt`
156+
- `-f, --force - Force the operation without confirmation`
157+
- `-n, --dry-run - Show what would happen without making changes`
158+
159+
**Examples:**
160+
161+
```bash
162+
# Delete by title
163+
sentry dashboard widget delete 'My Dashboard' --title 'Error Count'
164+
165+
# Delete by index
166+
sentry dashboard widget delete 12345 --index 2
167+
```
168+
169+
All commands also support `--json`, `--fields`, `--help`, `--log-level`, and `--verbose` flags.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: sentry-cli-events
3+
version: 0.25.0-dev.0
4+
description: View individual error events
5+
requires:
6+
bins: ["sentry"]
7+
auth: true
8+
---
9+
10+
# Event Commands
11+
12+
View Sentry events
13+
14+
### `sentry event view <org/project/event-id...>`
15+
16+
View details of a specific event
17+
18+
**Flags:**
19+
- `-w, --web - Open in browser`
20+
- `--spans <value> - Span tree depth limit (number, "all" for unlimited, "no" to disable) - (default: "3")`
21+
- `-f, --fresh - Bypass cache, re-detect projects, and fetch fresh data`
22+
23+
**Examples:**
24+
25+
```bash
26+
sentry event view abc123def456abc123def456abc12345
27+
28+
# Open in browser
29+
sentry event view abc123def456abc123def456abc12345 -w
30+
```
31+
32+
All commands also support `--json`, `--fields`, `--help`, `--log-level`, and `--verbose` flags.

0 commit comments

Comments
 (0)