Skip to content

Commit a5c4c5e

Browse files
betegonclaude
andcommitted
docs(commands): add alias info to subcommand help output
Each command group now mentions its plural shortcut in the help text, e.g. `sentry issue` shows that `sentry issues` is an alias for `sentry issue list`. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 1c096d9 commit a5c4c5e

File tree

9 files changed

+22
-9
lines changed

9 files changed

+22
-9
lines changed

src/commands/issue/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ export const issueRoute = buildRouteMap({
2626
"Examples:\n" +
2727
" sentry issue view @latest\n" +
2828
" sentry issue explain @most_frequent\n" +
29-
" sentry issue plan my-org/@latest",
29+
" sentry issue plan my-org/@latest\n\n" +
30+
"Alias: `sentry issues` → `sentry issue list`",
3031
hideRoute: {},
3132
},
3233
});

src/commands/log/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ export const logRoute = buildRouteMap({
1919
"View and stream logs from your Sentry projects.\n\n" +
2020
"Commands:\n" +
2121
" list List or stream logs from a project\n" +
22-
" view View details of a specific log entry",
22+
" view View details of a specific log entry\n\n" +
23+
"Alias: `sentry logs` → `sentry log list`",
2324
hideRoute: {},
2425
},
2526
});

src/commands/org/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ export const orgRoute = buildRouteMap({
99
},
1010
docs: {
1111
brief: "Work with Sentry organizations",
12-
fullDescription: "List and manage Sentry organizations you have access to.",
12+
fullDescription:
13+
"List and manage Sentry organizations you have access to.\n\n" +
14+
"Alias: `sentry orgs` → `sentry org list`",
1315
hideRoute: {},
1416
},
1517
});

src/commands/project/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ export const projectRoute = buildRouteMap({
1111
},
1212
docs: {
1313
brief: "Work with Sentry projects",
14-
fullDescription: "List and manage Sentry projects in your organizations.",
14+
fullDescription:
15+
"List and manage Sentry projects in your organizations.\n\n" +
16+
"Alias: `sentry projects` → `sentry project list`",
1517
hideRoute: {},
1618
},
1719
});

src/commands/repo/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ export const repoRoute = buildRouteMap({
88
docs: {
99
brief: "Work with Sentry repositories",
1010
fullDescription:
11-
"List and manage repositories connected to your Sentry organizations.",
11+
"List and manage repositories connected to your Sentry organizations.\n\n" +
12+
"Alias: `sentry repos` → `sentry repo list`",
1213
hideRoute: {},
1314
},
1415
});

src/commands/span/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ export const spanRoute = buildRouteMap({
1919
"View and explore individual spans within distributed traces.\n\n" +
2020
"Commands:\n" +
2121
" list List spans in a trace\n" +
22-
" view View details of specific spans",
22+
" view View details of specific spans\n\n" +
23+
"Alias: `sentry spans` → `sentry span list`",
2324
},
2425
});

src/commands/team/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ export const teamRoute = buildRouteMap({
77
},
88
docs: {
99
brief: "Work with Sentry teams",
10-
fullDescription: "List and manage teams in your Sentry organizations.",
10+
fullDescription:
11+
"List and manage teams in your Sentry organizations.\n\n" +
12+
"Alias: `sentry teams` → `sentry team list`",
1113
hideRoute: {},
1214
},
1315
});

src/commands/trace/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ export const traceRoute = buildRouteMap({
2222
"Commands:\n" +
2323
" list List recent traces in a project\n" +
2424
" view View details of a specific trace\n" +
25-
" logs View logs associated with a trace",
25+
" logs View logs associated with a trace\n\n" +
26+
"Alias: `sentry traces` → `sentry trace list`",
2627
hideRoute: {},
2728
},
2829
});

src/commands/trial/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ export const trialRoute = buildRouteMap({
99
},
1010
docs: {
1111
brief: "Manage product trials",
12-
fullDescription: "List and start product trials for your organization.",
12+
fullDescription:
13+
"List and start product trials for your organization.\n\n" +
14+
"Alias: `sentry trials` → `sentry trial list`",
1315
hideRoute: {},
1416
},
1517
});

0 commit comments

Comments
 (0)