Skip to content

Commit c4eefc8

Browse files
betegonclaude
andcommitted
docs(commands): add alias info to subcommand help output
Each command group and its list subcommand now mention the plural shortcut in help text, e.g. `sentry issue` and `sentry issue list` both show 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 c4eefc8

File tree

18 files changed

+40
-18
lines changed

18 files changed

+40
-18
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/issue/list.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1265,7 +1265,8 @@ export const listCommand = buildListCommand("issue", {
12651265
"Projects with fewer issues than their share give their surplus to others. " +
12661266
"Use --cursor / -c last to paginate through larger result sets.\n\n" +
12671267
"By default, only issues with activity in the last 90 days are shown. " +
1268-
"Use --period to adjust (e.g. --period 24h, --period 14d).",
1268+
"Use --period to adjust (e.g. --period 24h, --period 14d).\n\n" +
1269+
"Alias: `sentry issues` → `sentry issue list`",
12691270
},
12701271
output: issueListOutput,
12711272
parameters: {

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/log/list.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,8 @@ export const listCommand = buildListCommand("log", {
553553
" sentry log list -f 5 # Stream logs (5s poll interval)\n" +
554554
" sentry log list --limit 50 # Show last 50 logs\n" +
555555
" sentry log list -q 'level:error' # Filter to errors only\n" +
556-
" sentry log list --trace abc123def456abc123def456abc123de # Filter by trace",
556+
" sentry log list --trace abc123def456abc123def456abc123de # Filter by trace\n\n" +
557+
"Alias: `sentry logs` → `sentry log list`",
557558
},
558559
output: {
559560
human: createLogRenderer,

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/org/list.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ export const listCommand = buildCommand({
115115
"Examples:\n" +
116116
" sentry org list\n" +
117117
" sentry org list --limit 10\n" +
118-
" sentry org list --json",
118+
" sentry org list --json\n\n" +
119+
"Alias: `sentry orgs` → `sentry org list`",
119120
},
120121
output: { human: formatOrgListHuman },
121122
parameters: {

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/project/list.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -561,7 +561,8 @@ export const listCommand = buildListCommand("project", {
561561
"Filtering and output:\n" +
562562
" sentry project list --platform javascript # filter by platform\n" +
563563
" sentry project list --limit 50 # show more results\n" +
564-
" sentry project list --json # output as JSON",
564+
" sentry project list --json # output as JSON\n\n" +
565+
"Alias: `sentry projects` → `sentry project list`",
565566
},
566567
output: {
567568
human: (result: ListResult<ProjectWithOrg>) => {

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/repo/list.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ const docs: OrgListCommandDocs = {
6666
" sentry repo list # auto-detect or list all\n" +
6767
" sentry repo list my-org/ # list repositories in my-org (paginated)\n" +
6868
" sentry repo list --limit 10\n" +
69-
" sentry repo list --json",
69+
" sentry repo list --json\n\n" +
70+
"Alias: `sentry repos` → `sentry repo list`",
7071
};
7172

7273
export const listCommand = buildOrgListCommand(repoListConfig, docs, "repo");

0 commit comments

Comments
 (0)