docs(cmd): Help text tweaks

cmd/cmd.go

@@ -25,6 +25,7 @@ func NewCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:               "kubedb",
 		Short:             "Painlessly work with databases in Kubernetes.",
+		Long:              newDescription(),
 		Version:           buildVersion(),
 		DisableAutoGenTag: true,
 

cmd/description.go

@@ -0,0 +1,16 @@
+package cmd
+
+import (
+	"strings"
+
+	"github.com/clevyr/kubedb/internal/database"
+)
+
+func newDescription() string {
+	dbs := database.Names()
+
+	return `Painlessly work with databases in Kubernetes.
+
+Supported Databases:
+  ` + strings.Join(dbs, ", ")
+}

cmd/dump/description.go

@@ -12,17 +12,18 @@ func newDescription() string {
 
 	return `Dump a database to a sql file.
 
-Databases: ` + strings.Join(dbs, ", ") + `
+Supported Databases:
+  ` + strings.Join(dbs, ", ") + `
 
 File Path:
- - If the path is not provided, a filename will be generated.
- - If the path is a file, the database will be dumped there.
- - If the path is a directory, the database will be dumped to a generated filename in that directory.
- - Filenames are autogenerated based on the namespace and timestamp.
+  - If the path is not provided, a filename will be generated.
+  - If the path is a file, the database will be dumped there.
+  - If the path is a directory, the database will be dumped to a generated filename in that directory.
+  - Filenames are autogenerated based on the namespace and timestamp.
 
 Cloud Upload:
- - Use ` + "`s3://`" + ` for S3 and ` + "`gs://`" + ` for GCS.
- - If the URL only contains a bucket name or if the path ends with ` + "`/`" + `, then filenames are autogenerated similarly to local dumps.
- - Cloud config is loaded from the environment (similar to the ` + "`aws` and `gcloud`" + ` tools).
+  - Use "s3://" for S3 and "gs://" for GCS.
+  - If the URL only contains a bucket name or if the path ends with "/", then filenames are autogenerated similarly to local dumps.
+  - Cloud config is loaded from the environment (similar to the awsgcloud tools).
 `
 }

cmd/exec/description.go

@@ -10,7 +10,8 @@ import (
 func newDescription() string {
 	dbs := database.NamesForInterface[config.DBExecer]()
 
-	return `Connect to an interactive shell
+	return `Connect to an interactive shell.
 
-Databases: ` + strings.Join(dbs, ", ")
+Supported Databases:
+  ` + strings.Join(dbs, ", ")
 }

cmd/portforward/description.go

@@ -10,7 +10,8 @@ import (
 func newDescription() string {
 	dbs := database.NamesForInterface[config.DBHasPort]()
 
-	return `Set up a local port forward
+	return `Set up a local port forward.
 
-Databases: ` + strings.Join(dbs, ", ")
+Supported Databases:
+  ` + strings.Join(dbs, ", ")
 }

cmd/restore/description.go

@@ -12,10 +12,11 @@ func newDescription() string {
 
 	return `Restore a sql file to a database.
 
-Databases: ` + strings.Join(dbs, ", ") + `
+Supported Databases:
+  ` + strings.Join(dbs, ", ") + `
 
 Supported Input Filetypes:
-  - Raw sql file. Typically with the ` + "`" + `.sql` + "`" + ` extension
-  - Gzipped sql file. Typically with the ".sql.gz" extension
-  - For Postgres: custom dump file. Typically with the ".dmp" extension`
+  - Raw sql file. Typically with a ".sql" file extension
+  - Gzipped sql file. Typically with a ".sql.gz" file extension
+  - For Postgres: custom dump file. Typically with a ".dmp" file extension`
 }

docs/kubedb.md

@@ -2,6 +2,13 @@
 
 Painlessly work with databases in Kubernetes.
 
+### Synopsis
+
+Painlessly work with databases in Kubernetes.
+
+Supported Databases:
+  postgres, mariadb, mongodb, redis, meilisearch
+
 ### Options
 
 ```

docs/kubedb_dump.md

@@ -6,18 +6,19 @@ Dump a database to a sql file
 
 Dump a database to a sql file.
 
-Databases: postgres, mariadb, mongodb, meilisearch
+Supported Databases:
+  postgres, mariadb, mongodb, meilisearch
 
 File Path:
- - If the path is not provided, a filename will be generated.
- - If the path is a file, the database will be dumped there.
- - If the path is a directory, the database will be dumped to a generated filename in that directory.
- - Filenames are autogenerated based on the namespace and timestamp.
+  - If the path is not provided, a filename will be generated.
+  - If the path is a file, the database will be dumped there.
+  - If the path is a directory, the database will be dumped to a generated filename in that directory.
+  - Filenames are autogenerated based on the namespace and timestamp.
 
 Cloud Upload:
- - Use `s3://` for S3 and `gs://` for GCS.
- - If the URL only contains a bucket name or if the path ends with `/`, then filenames are autogenerated similarly to local dumps.
- - Cloud config is loaded from the environment (similar to the `aws` and `gcloud` tools).
+  - Use "s3://" for S3 and "gs://" for GCS.
+  - If the URL only contains a bucket name or if the path ends with "/", then filenames are autogenerated similarly to local dumps.
+  - Cloud config is loaded from the environment (similar to the awsgcloud tools).
 
 
 ```

docs/kubedb_exec.md

@@ -4,9 +4,10 @@ Connect to an interactive shell
 
 ### Synopsis
 
-Connect to an interactive shell
+Connect to an interactive shell.
 
-Databases: postgres, mariadb, mongodb, redis
+Supported Databases:
+  postgres, mariadb, mongodb, redis
 
 ```
 kubedb exec [flags]

docs/kubedb_port-forward.md

@@ -4,9 +4,10 @@ Set up a local port forward
 
 ### Synopsis
 
-Set up a local port forward
+Set up a local port forward.
 
-Databases: postgres, mariadb, mongodb, redis, meilisearch
+Supported Databases:
+  postgres, mariadb, mongodb, redis, meilisearch
 
 ```
 kubedb port-forward [local_port] [flags]

docs/kubedb_restore.md

@@ -6,12 +6,13 @@ Restore a sql file to a database
 
 Restore a sql file to a database.
 
-Databases: postgres, mariadb, mongodb, meilisearch
+Supported Databases:
+  postgres, mariadb, mongodb, meilisearch
 
 Supported Input Filetypes:
-  - Raw sql file. Typically with the `.sql` extension
-  - Gzipped sql file. Typically with the ".sql.gz" extension
-  - For Postgres: custom dump file. Typically with the ".dmp" extension
+  - Raw sql file. Typically with a ".sql" file extension
+  - Gzipped sql file. Typically with a ".sql.gz" file extension
+  - For Postgres: custom dump file. Typically with a ".dmp" file extension
 
 ```
 kubedb restore filename [flags]