diff --git a/client/cmd/debug.go b/client/cmd/debug.go index bfb2e61c1..18f3547ca 100644 --- a/client/cmd/debug.go +++ b/client/cmd/debug.go @@ -33,7 +33,7 @@ var ( var debugCmd = &cobra.Command{ Use: "debug", Short: "Debugging commands", - Long: "Provides commands for debugging and logging control within the NetBird daemon.", + Long: "Commands for debugging and logging within the NetBird daemon.", } var debugBundleCmd = &cobra.Command{ diff --git a/client/cmd/down.go b/client/cmd/down.go index cfa69bce2..3ce51c678 100644 --- a/client/cmd/down.go +++ b/client/cmd/down.go @@ -14,7 +14,8 @@ import ( var downCmd = &cobra.Command{ Use: "down", - Short: "down netbird connections", + Short: "Disconnect from the NetBird network", + Long: "Disconnect the NetBird client from the network and management service. This will terminate all active connections with the remote peers.", RunE: func(cmd *cobra.Command, args []string) error { SetFlagsFromEnvVars(rootCmd) diff --git a/client/cmd/login.go b/client/cmd/login.go index a6ae13ed8..92de6abdb 100644 --- a/client/cmd/login.go +++ b/client/cmd/login.go @@ -31,7 +31,8 @@ func init() { var loginCmd = &cobra.Command{ Use: "login", - Short: "login to the NetBird Management Service (first run)", + Short: "Log in to the NetBird network", + Long: "Log in to the NetBird network using a setup key or SSO", RunE: func(cmd *cobra.Command, args []string) error { if err := setEnvAndFlags(cmd); err != nil { return fmt.Errorf("set env and flags: %v", err) diff --git a/client/cmd/logout.go b/client/cmd/logout.go index 5e04a8c3a..1a5281acb 100644 --- a/client/cmd/logout.go +++ b/client/cmd/logout.go @@ -14,7 +14,8 @@ import ( var logoutCmd = &cobra.Command{ Use: "deregister", Aliases: []string{"logout"}, - Short: "deregister from the NetBird Management Service and delete peer", + Short: "Deregister from the NetBird management service and delete this peer", + Long: "This command will deregister the current peer from the NetBird management service and all associated configuration. Use with caution as this will remove the peer from the network.", RunE: func(cmd *cobra.Command, args []string) error { SetFlagsFromEnvVars(rootCmd) diff --git a/client/cmd/networks.go b/client/cmd/networks.go index 7b9724bc5..05823b8bb 100644 --- a/client/cmd/networks.go +++ b/client/cmd/networks.go @@ -15,7 +15,7 @@ var appendFlag bool var networksCMD = &cobra.Command{ Use: "networks", Aliases: []string{"routes"}, - Short: "Manage networks", + Short: "Manage connections to NetBird Networks and Resources", Long: `Commands to list, select, or deselect networks. Replaces the "routes" command.`, } diff --git a/client/cmd/profile.go b/client/cmd/profile.go index 0cb068d05..d6e81760f 100644 --- a/client/cmd/profile.go +++ b/client/cmd/profile.go @@ -16,13 +16,13 @@ import ( var profileCmd = &cobra.Command{ Use: "profile", - Short: "manage NetBird profiles", - Long: `Manage NetBird profiles, allowing you to list, switch, and remove profiles.`, + Short: "Manage NetBird client profiles", + Long: `Commands to list, add, remove, and switch profiles. Profiles allow you to maintain different accounts in one client app.`, } var profileListCmd = &cobra.Command{ Use: "list", - Short: "list all profiles", + Short: "List all profiles", Long: `List all available profiles in the NetBird client.`, Aliases: []string{"ls"}, RunE: listProfilesFunc, @@ -30,7 +30,7 @@ var profileListCmd = &cobra.Command{ var profileAddCmd = &cobra.Command{ Use: "add ", - Short: "add a new profile", + Short: "Add a new profile", Long: `Add a new profile to the NetBird client. The profile name must be unique.`, Args: cobra.ExactArgs(1), RunE: addProfileFunc, @@ -38,16 +38,16 @@ var profileAddCmd = &cobra.Command{ var profileRemoveCmd = &cobra.Command{ Use: "remove ", - Short: "remove a profile", - Long: `Remove a profile from the NetBird client. The profile must not be active.`, + Short: "Remove a profile", + Long: `Remove a profile from the NetBird client. The profile must not be inactive.`, Args: cobra.ExactArgs(1), RunE: removeProfileFunc, } var profileSelectCmd = &cobra.Command{ Use: "select ", - Short: "select a profile", - Long: `Select a profile to be the active profile in the NetBird client. The profile must exist.`, + Short: "Select a profile", + Long: `Make the specified profile active. This will switch the client to use the selected profile's configuration.`, Args: cobra.ExactArgs(1), RunE: selectProfileFunc, } diff --git a/client/cmd/service.go b/client/cmd/service.go index b0431a69b..e55465875 100644 --- a/client/cmd/service.go +++ b/client/cmd/service.go @@ -19,7 +19,7 @@ import ( var serviceCmd = &cobra.Command{ Use: "service", - Short: "manages NetBird service", + Short: "Manage the NetBird daemon service", } var ( diff --git a/client/cmd/service_installer.go b/client/cmd/service_installer.go index 293a276dc..075ead44e 100644 --- a/client/cmd/service_installer.go +++ b/client/cmd/service_installer.go @@ -107,7 +107,7 @@ func createServiceConfigForInstall() (*service.Config, error) { var installCmd = &cobra.Command{ Use: "install", - Short: "installs NetBird service", + Short: "Install NetBird service", RunE: func(cmd *cobra.Command, args []string) error { if err := setupServiceCommand(cmd); err != nil { return err diff --git a/client/cmd/ssh.go b/client/cmd/ssh.go index 035d06727..5358ddacb 100644 --- a/client/cmd/ssh.go +++ b/client/cmd/ssh.go @@ -40,7 +40,7 @@ var sshCmd = &cobra.Command{ return nil }, - Short: "connect to a remote SSH server", + Short: "Connect to a remote SSH server", RunE: func(cmd *cobra.Command, args []string) error { SetFlagsFromEnvVars(rootCmd) SetFlagsFromEnvVars(cmd) diff --git a/client/cmd/status.go b/client/cmd/status.go index edc443f79..723f2367c 100644 --- a/client/cmd/status.go +++ b/client/cmd/status.go @@ -32,7 +32,8 @@ var ( var statusCmd = &cobra.Command{ Use: "status", - Short: "status of the Netbird Service", + Short: "Display NetBird client status", + Long: "Display the current status of the NetBird client, including connection status, peer information, and network details.", RunE: statusFunc, } diff --git a/client/cmd/up.go b/client/cmd/up.go index 8732a687d..1fa58e6ed 100644 --- a/client/cmd/up.go +++ b/client/cmd/up.go @@ -53,7 +53,8 @@ var ( upCmd = &cobra.Command{ Use: "up", - Short: "install, login and start NetBird client", + Short: "Connect to the NetBird network", + Long: "Connect to the NetBird network using the provided setup key or SSO auth. This command will bring up the WireGuard interface, connect to the management server, and establish peer-to-peer connections with other peers in the network if required.", RunE: upFunc, } ) diff --git a/client/cmd/version.go b/client/cmd/version.go index 03541b85e..249854444 100644 --- a/client/cmd/version.go +++ b/client/cmd/version.go @@ -9,7 +9,7 @@ import ( var ( versionCmd = &cobra.Command{ Use: "version", - Short: "prints NetBird version", + Short: "Print the NetBird's client application version", Run: func(cmd *cobra.Command, args []string) { cmd.SetOut(cmd.OutOrStdout()) cmd.Println(version.NetbirdVersion())