feat: Expose command in docs

erezrokah · erezrokah · commit 09ab7a7c9258 · 2024-03-22T16:24:25.000Z
diff --git a/cli/cmd/test_connection.go b/cli/cmd/test_connection.go
@@ -85,7 +85,6 @@ func newCmdTestConnection() *cobra.Command {
 		Example: testConnectionExample,
 		Args:    cobra.MinimumNArgs(1),
 		RunE:    testConnection,
-		Hidden:  true,
 	}
 	return cmd
 }
diff --git a/website/pages/docs/reference/cli/cloudquery.md b/website/pages/docs/reference/cli/cloudquery.md
@@ -37,4 +37,5 @@ Find more information at:
 * [cloudquery switch](/docs/reference/cli/cloudquery_switch)	 - Switches between teams.
 * [cloudquery sync](/docs/reference/cli/cloudquery_sync)	 - Sync resources from configured source plugins to destinations
 * [cloudquery tables](/docs/reference/cli/cloudquery_tables)	 - Generate documentation for all supported tables of source plugins specified in the spec(s)
+* [cloudquery test-connection](/docs/reference/cli/cloudquery_test-connection)	 - Test plugin connections to sources and destinations
 
diff --git a/website/pages/docs/reference/cli/cloudquery_test-connection.md b/website/pages/docs/reference/cli/cloudquery_test-connection.md
@@ -0,0 +1,47 @@
+---
+title: "test-connection"
+---
+## cloudquery test-connection
+
+Test plugin connections to sources and destinations
+
+### Synopsis
+
+Test plugin connections to sources and destinations
+
+```
+cloudquery test-connection [files or directories] [flags]
+```
+
+### Examples
+
+```
+# Test plugin connections to sources and destinations
+cloudquery test-connection ./directory
+# Test plugin connections from directories and files
+cloudquery test-connection ./directory ./aws.yml ./pg.yml
+
+```
+
+### Options
+
+```
+  -h, --help   help for test-connection
+```
+
+### Options inherited from parent commands
+
+```
+      --cq-dir string            directory to store cloudquery files, such as downloaded plugins (default ".cq")
+      --log-console              enable console logging
+      --log-file-name string     Log filename (default "cloudquery.log")
+      --log-format string        Logging format (json, text) (default "text")
+      --log-level string         Logging level (trace, debug, info, warn, error) (default "info")
+      --no-log-file              Disable logging to file
+      --telemetry-level string   Telemetry level (none, errors, stats, all) (default "all")
+```
+
+### SEE ALSO
+
+* [cloudquery](/docs/reference/cli/cloudquery)	 - CloudQuery CLI
+

Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,6 @@ func newCmdTestConnection() *cobra.Command {`
`85`	`85`	`Example: testConnectionExample,`
`86`	`86`	`Args: cobra.MinimumNArgs(1),`
`87`	`87`	`RunE: testConnection,`
`88`		`- Hidden: true,`
`89`	`88`	`}`
`90`	`89`	`return cmd`
`91`	`90`	`}`