Skip to content

Commit e82d588

Browse files
committed
docs(cli): cross-reference insight from incident list --help; clarify insight group purpose
Add "See also: fduty insight team|responder|channel" to incident list Long description so agents discover the analytics API without a user prompt. Update insight group Short to call out it is preferred for metrics queries.
1 parent e93ef96 commit e82d588

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

internal/cli/incident.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ func newIncidentListCmd() *cobra.Command {
8080
cmd := &cobra.Command{
8181
Use: "list",
8282
Short: "List incidents",
83-
Long: curatedLong("List incidents matching the given filters. The --since/--until window must be < 31 days; --limit max is 100.", "Incidents", "List"),
83+
Long: curatedLong("List incidents matching the given filters. The --since/--until window must be < 31 days; --limit max is 100.\n\nSee also: fduty insight team|responder|channel for aggregated metrics (MTTA, MTTR, noise reduction) instead of paginating raw incidents.", "Incidents", "List"),
8484
RunE: func(cmd *cobra.Command, args []string) error {
8585
return runCommand(cmd, args, func(ctx *RunContext) error {
8686
startTime, err := timeutil.Parse(since)

internal/cli/insight.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
func newInsightCmd() *cobra.Command {
1414
cmd := &cobra.Command{
1515
Use: "insight",
16-
Short: "Query insight metrics",
16+
Short: "Query aggregated incident metrics by team/responder/channel (preferred over incident list for analytics)",
1717
}
1818
// insight team/channel/responder are now served by the generated commands
1919
// (richer flag set: severities, *_ids, fields, aggregate-unit, …; relative

0 commit comments

Comments
 (0)