From a5315059e372041f156cb1c562623713f08680a3 Mon Sep 17 00:00:00 2001 From: Andrew Lavery Date: Thu, 26 Mar 2026 17:46:35 -0400 Subject: [PATCH 1/3] network commands should have docs format matching others --- cli/cmd/network.go | 2 +- cli/cmd/network_report.go | 8 ++++---- cli/cmd/network_update.go | 10 +++++----- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/cli/cmd/network.go b/cli/cmd/network.go index 6a98cd306..c63991064 100644 --- a/cli/cmd/network.go +++ b/cli/cmd/network.go @@ -20,7 +20,7 @@ With this command you can list the networks in use by VMs and clusters.`, replicated network ls # Update a network with an airgap policy -replicated network update --policy airgap +replicated network update NETWORK_ID --policy airgap `, Hidden: false, } diff --git a/cli/cmd/network_report.go b/cli/cmd/network_report.go index 698889678..2ef9836bf 100644 --- a/cli/cmd/network_report.go +++ b/cli/cmd/network_report.go @@ -22,20 +22,20 @@ func (r *runners) InitNetworkReport(parent *cobra.Command) *cobra.Command { Long: `Get a network report showing detailed network activity for a specified network. 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 --collect-report'. +pods, processes, and DNS queries. Reports must be enabled with 'replicated network update NETWORK_ID --collect-report'. 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 (external traffic only) -replicated network report +replicated network report NETWORK_ID # Get aggregated summary with statistics. Only available for networks that have been terminated. -replicated network report --summary +replicated network report NETWORK_ID --summary # Watch for new network events in real-time -replicated network report --watch`, +replicated network report NETWORK_ID --watch`, RunE: r.getNetworkReport, ValidArgsFunction: r.completeNetworkIDs, Hidden: false, diff --git a/cli/cmd/network_update.go b/cli/cmd/network_update.go index 1ebeb0f91..4e149d3a8 100644 --- a/cli/cmd/network_update.go +++ b/cli/cmd/network_update.go @@ -20,19 +20,19 @@ 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 --policy airgap +replicated network update NETWORK_ID --policy airgap # Set network policy to open -replicated network update --policy open +replicated network update NETWORK_ID --policy open # Enable network traffic reporting -replicated network update --collect-report +replicated network update NETWORK_ID --collect-report # Disable network reporting -replicated network update --collect-report=false +replicated network update NETWORK_ID --collect-report=false # Update multiple settings at once -replicated network update --policy airgap --collect-report +replicated network update NETWORK_ID --policy airgap --collect-report `, RunE: r.updateNetwork, SilenceUsage: true, From 9c720d1e2574fd8474783b83a14cf1f7a8744d16 Mon Sep 17 00:00:00 2001 From: Andrew Lavery Date: Thu, 26 Mar 2026 18:08:49 -0400 Subject: [PATCH 2/3] update USE --- cli/cmd/network_report.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cli/cmd/network_report.go b/cli/cmd/network_report.go index 2ef9836bf..5dceab04d 100644 --- a/cli/cmd/network_report.go +++ b/cli/cmd/network_report.go @@ -17,7 +17,7 @@ import ( func (r *runners) InitNetworkReport(parent *cobra.Command) *cobra.Command { cmd := &cobra.Command{ - Use: "report [network-id]", + Use: "report NETWORK_ID", Short: "Get network report", Long: `Get a network report showing detailed network activity for a specified network. From 47bb51dcf2232e59bf45172ef3c96cdee9c1d9f9 Mon Sep 17 00:00:00 2001 From: Andrew Lavery Date: Thu, 26 Mar 2026 18:09:25 -0400 Subject: [PATCH 3/3] f --- cli/cmd/network_report.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cli/cmd/network_report.go b/cli/cmd/network_report.go index 5dceab04d..ce32803c7 100644 --- a/cli/cmd/network_report.go +++ b/cli/cmd/network_report.go @@ -17,7 +17,7 @@ import ( func (r *runners) InitNetworkReport(parent *cobra.Command) *cobra.Command { cmd := &cobra.Command{ - Use: "report NETWORK_ID", + Use: "report [NETWORK_ID]", Short: "Get network report", Long: `Get a network report showing detailed network activity for a specified network.