@@ -22,7 +22,7 @@ use crate::essential::{
2222 read_configs,
2323 update_cli,
2424} ;
25- use crate :: install:: { install_cortexflow, install_simple_example} ;
25+ use crate :: install:: { install_cortexflow, install_simple_example } ;
2626use crate :: logs:: logs_command;
2727use crate :: monitoring:: { list_features, monitor_identity_events } ;
2828use crate :: service:: { describe_service, list_services } ;
@@ -50,17 +50,17 @@ enum Commands {
5050 #[ command( name = "set-env" ) ] SetEnv ( SetArgs ) ,
5151 #[ command( name = "get-env" ) ]
5252 GetEnv ,
53- #[ command( name = "install" ) ] Install ( InstallArgs ) ,
54- #[ command( name = "uninstall" ) ]
53+ #[ command( name = "install" , about = "Manage installation" ) ] Install ( InstallArgs ) ,
54+ #[ command( name = "uninstall" , about = "Manage uninstallation" ) ]
5555 Uninstall ,
56- #[ command( name = "update" ) ]
56+ #[ command( name = "update" , about= "Check for updates" ) ]
5757 Update ,
58- #[ command( name = "info" ) ]
58+ #[ command( name = "info" , about= "Check core info" ) ]
5959 Info ,
60- #[ command( name = "service" ) ] Service ( ServiceArgs ) ,
61- #[ command( name = "status" ) ] Status ( StatusArgs ) ,
62- #[ command( name = "logs" ) ] Logs ( LogsArgs ) ,
63- #[ command( name = "monitoring" ) ] Monitor ( MonitorArgs ) ,
60+ #[ command( name = "service" , about= "Manage services" ) ] Service ( ServiceArgs ) ,
61+ #[ command( name = "status" , about= "Check components status" ) ] Status ( StatusArgs ) ,
62+ #[ command( name = "logs" , about= "Check services logs" ) ] Logs ( LogsArgs ) ,
63+ #[ command( name = "monitoring" , about = "Monitoring commands" ) ] Monitor ( MonitorArgs ) ,
6464}
6565#[ derive( Args , Debug , Clone ) ]
6666struct SetArgs {
@@ -82,29 +82,35 @@ struct InstallArgs {
8282//install subcommands
8383#[ derive( Subcommand , Debug , Clone ) ]
8484enum InstallCommands {
85- #[ command( name = "cortexflow" ) ]
85+ #[ command( name = "cortexflow" , about = "Install all the CortexBrain core components" ) ]
8686 All ,
87- #[ command( name = "simple-example" ) ]
87+ #[ command(
88+ name = "simple-example" ,
89+ about = "Deploys a simple example contained in deploy-test-pod.yaml"
90+ ) ]
8891 TestPods ,
8992}
9093
9194//monitoring subcommands
9295#[ derive( Subcommand , Debug , Clone ) ]
9396enum MonitorCommands {
94- #[ command( name = "list" ) ]
97+ #[ command( name = "list" , about = "List all the agent API available functions" ) ]
9598 List ,
96- #[ command( name = "connections" ) ]
99+ #[ command(
100+ name = "connections" ,
101+ about = "Monitor the recent connections detected by the identity service"
102+ ) ]
97103 Connections ,
98104}
99105
100106//service subcommands
101107#[ derive( Subcommand , Debug , Clone ) ]
102108enum ServiceCommands {
103- #[ command( name = "list" ) ] List {
109+ #[ command( name = "list" , about= "Check services list" ) ] List {
104110 #[ arg( long) ]
105111 namespace : Option < String > ,
106112 } ,
107- #[ command( name = "describe" ) ] Describe {
113+ #[ command( name = "describe" , about= "Describe service" ) ] Describe {
108114 service_name : String ,
109115 #[ arg( long) ]
110116 namespace : Option < String > ,
0 commit comments