Expand command descriptions

cmd/airflow.go

@@ -27,13 +27,13 @@ var (
 	airflowRootCmd = &cobra.Command{
 		Use:   "airflow",
 		Short: "Manage airflow projects and deployments",
-		Long:  "Manage airflow projects and deployments",
+		Long:  "Airflow projects are a single top-level directory which represents a single production Airflow deployment",
 	}
 
 	airflowInitCmd = &cobra.Command{
 		Use:   "init",
 		Short: "Scaffold a new airflow project",
-		Long:  "Scaffold a new airflow project",
+		Long:  "Scaffold a new airflow project directory. Will create the necessary files to begin development locally as well as be deployed to the Astronomer Platform.",
 		RunE:  airflowInit,
 	}
 

cmd/auth.go

@@ -17,13 +17,13 @@ var (
 	authRootCmd = &cobra.Command{
 		Use:   "auth",
 		Short: "Mangage astronomer identity",
-		Long:  "Manage astronomer identity",
+		Long:  "Handles authentication to the Astronomer Platform",
 	}
 
 	authLoginCmd = &cobra.Command{
 		Use:   "login",
 		Short: "Login to Astronomer services",
-		Long:  "Login to Astronomer services",
+		Long:  "Authenticate to houston-api using oAuth or basic auth.",
 		RunE:  authLogin,
 	}
 

cmd/deployment.go

@@ -9,7 +9,7 @@ var (
 		Use:     "deployment",
 		Aliases: []string{"de"},
 		Short:   "Manage airflow deployments",
-		Long:    "Manage airflow deployments",
+		Long:    "Deployments are individual Airflow clusters running on an installation of the Astronomer platform.",
 	}
 
 	deploymentCreateCmd = &cobra.Command{

cmd/user.go

@@ -15,7 +15,7 @@ var (
 	userRootCmd = &cobra.Command{
 		Use:   "user",
 		Short: "Manage astronomer user",
-		Long:  "Manage astronomer user",
+		Long:  "Users represents a human who has authenticated with the Astronomer platform",
 	}
 
 	userListCmd = &cobra.Command{

cmd/version.go

@@ -11,7 +11,7 @@ var (
 	versionCmd  = &cobra.Command{
 		Use:   "version",
 		Short: "Astronomer CLI version",
-		Long:  "Astronomer CLI version",
+		Long:  "The astro-cli semantic version and git commit tied to that release.",
 		RunE:  printVersion,
 	}
 

cmd/workspace.go

@@ -9,14 +9,15 @@ var (
 		Use:     "workspace",
 		Aliases: []string{"wo", "ws"},
 		Short:   "Manage Astronomer workspaces",
-		Long:    "Manage astronomer workspaces",
+		Long:    "Workspaces contain a group of Airflow Cluster Deployments. The creator of the workspace can invite other users into it",
 	}
 
 	workspaceListCmd = &cobra.Command{
-		Use:   "list",
-		Short: "List astronomer workspaces",
-		Long:  "List astronomer workspaces",
-		RunE:  workspaceList,
+		Use:     "list",
+		Aliases: []string{"ls"},
+		Short:   "List astronomer workspaces",
+		Long:    "List astronomer workspaces",
+		RunE:    workspaceList,
 	}
 
 	workspaceCreateCmd = &cobra.Command{
@@ -58,18 +59,20 @@ func init() {
 	workspaceRootCmd.AddCommand(workspaceUpdateCmd)
 }
 
-func workspaceList(cmd *cobra.Command, args []string) error {
+func workspaceCreate(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func workspaceCreate(cmd *cobra.Command, args []string) error {
+func workspaceList(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
+// TODO
 func workspaceDelete(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
+// TODO
 func workspaceUpdate(cmd *cobra.Command, args []string) error {
 	return nil
 }