Update --help for network report (#592)

Author: hyu

cli/cmd/network_report.go

@@ -19,15 +19,23 @@ func (r *runners) InitNetworkReport(parent *cobra.Command) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "report [network-id]",
 		Short: "Get network report",
-		Long:  "Get a network report showing traffic analysis for a specified network",
-		Example: `# Get report for a network by ID (using positional argument)
-replicated network report abc123
+		Long: `Get a network report showing detailed network activity for a specified network.
 
-# Get report for a network by ID (using flag)
-replicated network report --id abc123
+The report shows individual network events including source/destination IPs, ports, protocols, 
+pods, processes, and DNS queries. Reports must be enabled with 'replicated network update <network-id> --collect-report'.
 
-# Watch for new network events (JSON Lines format)
-replicated network report abc123 --watch`,
+Output formats:
+  - Default: Full event details in JSON format
+  - --summary: Aggregated statistics with top domains and destinations
+  - --watch: Continuous stream of new events in JSON Lines format`,
+		Example: `# Get full network traffic report
+replicated network report <network-id>
+
+# Get aggregated summary with statistics
+replicated network report <network-id> --summary
+
+# Watch for new network events in real-time
+replicated network report <network-id> --watch`,
 		RunE:              r.getNetworkReport,
 		ValidArgsFunction: r.completeNetworkIDs,
 		Hidden:            true,
@@ -37,8 +45,8 @@ replicated network report abc123 --watch`,
 	cmd.Flags().StringVar(&r.args.networkReportID, "id", "", "Network ID to get report for")
 	cmd.RegisterFlagCompletionFunc("id", r.completeNetworkIDs)
 
-	cmd.Flags().BoolVarP(&r.args.networkReportWatch, "watch", "w", false, "Watch for new network events")
-	cmd.Flags().BoolVar(&r.args.networkReportSummary, "summary", false, "Get the report summary ")
+	cmd.Flags().BoolVarP(&r.args.networkReportWatch, "watch", "w", false, "Watch for new network events in real-time (polls every 2 seconds)")
+	cmd.Flags().BoolVar(&r.args.networkReportSummary, "summary", false, "Get aggregated report summary with statistics instead of individual events")
 
 	return cmd
 }

cli/cmd/network_update.go

@@ -12,20 +12,27 @@ func (r *runners) InitNetworkUpdateCommand(parent *cobra.Command) *cobra.Command
 	cmd := &cobra.Command{
 		Use:   "update [ID_OR_NAME]",
 		Short: "Update network settings",
-		Long: `The 'update' command allows you to update various settings of a test network.
+		Long: `The 'update' command allows you to update various settings of a test network, including network policy and report collection.
 
-You can either specify the network ID directly or provide the network name, and the command will resolve the corresponding network ID.
+You can either specify the network ID or name directly as a positional argument, or provide it using the '--id' or '--name' flags.
 
-Network Policies are currently a beta feature.`,
-		Example: `# Update a network using its ID
+Network policies control network traffic behavior:
+  - open: No restrictions on network traffic (default)
+  - airgap: Blocks all network egress to simulate air-gapped environments`,
+		Example: `# Set network policy to airgap
 replicated network update <network-id> --policy airgap
 
-# Update a network using its name
-replicated network update <network-name> --policy airgap
+# Set network policy to open
+replicated network update <network-id> --policy open
 
-# Update using --id or --name flags
-replicated network update --id <network-id> --policy airgap
-replicated network update --name <network-name> --policy airgap
+# Enable network traffic reporting
+replicated network update <network-id> --collect-report
+
+# Disable network reporting
+replicated network update <network-id> --collect-report=false
+
+# Update multiple settings at once
+replicated network update <network-id> --policy airgap --collect-report
 `,
 		RunE:              r.updateNetwork,
 		SilenceUsage:      true,
@@ -41,9 +48,6 @@ replicated network update --name <network-name> --policy airgap
 
 	cmd.Flags().StringVarP(&r.args.updateNetworkPolicy, "policy", "p", "", "Update network policy setting")
 	cmd.Flags().BoolVarP(&r.args.updateNetworkCollectReport, "collect-report", "r", false, "Enable report collection on this network (use --collect-report=false to disable)")
-	// TODO: Remove this once report collection is Beta, ensure we add
-	// examples in the above help text as well.
-	cmd.Flags().MarkHidden("collect-report")
 	cmd.Flags().StringVar(&r.outputFormat, "output", "table", "The output format to use. One of: json|table|wide")
 
 	return cmd