docs: update CLI reference pages (#3830)

docs/docs/cli/reference/cli-sidebar.js

@@ -92,6 +92,11 @@ const pages = [
 		label: "tracetest version",
 		id: "cli/reference/tracetest_version"
 	},
+    {
+        type: "doc",
+		label: "tracetest wait",
+		id: "cli/reference/tracetest_wait"
+	},
 ]
 
 module.exports = pages;

docs/docs/cli/reference/tracetest.md

@@ -27,9 +27,10 @@ CLI to configure, install and execute tests on a Tracetest server
 * [tracetest export](tracetest_export.md)	 - Export resource
 * [tracetest get](tracetest_get.md)	 - Get resource
 * [tracetest list](tracetest_list.md)	 - List resources
-* [tracetest run](tracetest_run.md)	 - run resources
+* [tracetest run](tracetest_run.md)	 - Run tests and test suites
 * [tracetest server](tracetest_server.md)	 - Manage your tracetest server
 * [tracetest start](tracetest_start.md)	 - Start Tracetest
 * [tracetest version](tracetest_version.md)	 - Display this CLI tool version
+* [tracetest wait](tracetest_wait.md)	 - Waits for a run group to be finished
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_apply.md

@@ -31,4 +31,4 @@ tracetest apply analyzer|config|datastore|demo|env|organization|pollingprofile|t
 
 * [tracetest](tracetest.md)	 - CLI to configure, install and execute tests on a Tracetest server
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_completion.md

@@ -32,4 +32,4 @@ See each sub-command's help for details on how to use the generated script.
 * [tracetest completion powershell](tracetest_completion_powershell.md)	 - Generate the autocompletion script for powershell
 * [tracetest completion zsh](tracetest_completion_zsh.md)	 - Generate the autocompletion script for zsh
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_completion_bash.md

@@ -57,4 +57,4 @@ tracetest completion bash
 
 * [tracetest completion](tracetest_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_completion_fish.md

@@ -46,4 +46,4 @@ tracetest completion fish [flags]
 
 * [tracetest completion](tracetest_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_completion_powershell.md

@@ -41,4 +41,4 @@ tracetest completion powershell [flags]
 
 * [tracetest completion](tracetest_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_completion_zsh.md

@@ -61,4 +61,4 @@ tracetest completion zsh [flags]
 
 * [tracetest completion](tracetest_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_configure.md

@@ -35,4 +35,4 @@ tracetest configure [flags]
 
 * [tracetest](tracetest.md)	 - CLI to configure, install and execute tests on a Tracetest server
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_dashboard.md

@@ -30,4 +30,4 @@ tracetest dashboard [flags]
 
 * [tracetest](tracetest.md)	 - CLI to configure, install and execute tests on a Tracetest server
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_delete.md

@@ -31,4 +31,4 @@ tracetest delete analyzer|config|datastore|demo|env|organization|pollingprofile|
 
 * [tracetest](tracetest.md)	 - CLI to configure, install and execute tests on a Tracetest server
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_export.md

@@ -32,4 +32,4 @@ tracetest export analyzer|config|datastore|demo|env|organization|pollingprofile|
 
 * [tracetest](tracetest.md)	 - CLI to configure, install and execute tests on a Tracetest server
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_get.md

@@ -31,4 +31,4 @@ tracetest get analyzer|config|datastore|demo|env|organization|pollingprofile|tes
 
 * [tracetest](tracetest.md)	 - CLI to configure, install and execute tests on a Tracetest server
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_list.md

@@ -35,4 +35,4 @@ tracetest list analyzer|config|datastore|demo|env|organization|pollingprofile|te
 
 * [tracetest](tracetest.md)	 - CLI to configure, install and execute tests on a Tracetest server
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_run.md

@@ -1,22 +1,23 @@
 # CLI Reference
 ## tracetest run
 
-run resources
+Run tests and test suites
 
 ### Synopsis
 
-run resources
+Run tests and test suites
 
 ```
-tracetest run testsuite|test [flags]
+tracetest run [test|testsuite] [flags]
 ```
 
 ### Options
 
 ```
-  -f, --file string              path to the definition file
+  -f, --file strings             path to the definition file (can be defined multiple times)
+  -g, --group string             Sets the Run Group ID for the run. This is used to group multiple runs together.
   -h, --help                     help for run
-      --id string                id of the resource to run
+      --id strings               id of the resource to run (can be defined multiple times)
   -j, --junit string             file path to save test results in junit format
       --required-gates strings   override default required gate. valid options: analyzer-score, analyzer-rules, test-specs
   -W, --skip-result-wait         do not wait for results. exit immediately after test run started
@@ -36,4 +37,4 @@ tracetest run testsuite|test [flags]
 
 * [tracetest](tracetest.md)	 - CLI to configure, install and execute tests on a Tracetest server
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_server.md

@@ -31,4 +31,4 @@ tracetest server [flags]
 * [tracetest](tracetest.md)	 - CLI to configure, install and execute tests on a Tracetest server
 * [tracetest server install](tracetest_server_install.md)	 - Install a new Tracetest server
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_server_install.md

@@ -34,4 +34,4 @@ tracetest server install [flags]
 
 * [tracetest server](tracetest_server.md)	 - Manage your tracetest server
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_start.md

@@ -14,13 +14,14 @@ tracetest start [flags]
 ### Options
 
 ```
-      --api-key string        agent api key
-      --environment string    environment id
-  -h, --help                  help for start
-  -l, --log-level string      set the agent log level (default "debug")
-  -m, --mode string           set how the agent will start (default "desktop")
-      --organization string   organization id
-      --token string          token authentication key
+      --api-key string              agent api key
+      --collector-endpoint string   address of the OTel Collector endpoint
+      --environment string          environment id
+  -h, --help                        help for start
+  -l, --log-level string            set the agent log level (default "debug")
+  -m, --mode string                 set how the agent will start (default "desktop")
+      --organization string         organization id
+      --token string                token authentication key
 ```
 
 ### Options inherited from parent commands
@@ -36,4 +37,4 @@ tracetest start [flags]
 
 * [tracetest](tracetest.md)	 - CLI to configure, install and execute tests on a Tracetest server
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_version.md

@@ -30,4 +30,4 @@ tracetest version [flags]
 
 * [tracetest](tracetest.md)	 - CLI to configure, install and execute tests on a Tracetest server
 
-###### Auto generated by spf13/cobra on 16-Feb-2024
+###### Auto generated by spf13/cobra on 29-Apr-2024

docs/docs/cli/reference/tracetest_wait.md

@@ -0,0 +1,34 @@
+# CLI Reference
+## tracetest wait
+
+Waits for a run group to be finished
+
+### Synopsis
+
+Waits for a run group to be finished and displays the result
+
+```
+tracetest wait group [flags]
+```
+
+### Options
+
+```
+  -h, --help        help for wait
+      --id string   Run Group ID to wait
+```
+
+### Options inherited from parent commands
+
+```
+  -c, --config string       config file will be used by the CLI (default "config.yml")
+  -o, --output string       output format [pretty|json|yaml]
+  -s, --server-url string   server url
+  -v, --verbose             display debug information
+```
+
+### SEE ALSO
+
+* [tracetest](tracetest.md)	 - CLI to configure, install and execute tests on a Tracetest server
+
+###### Auto generated by spf13/cobra on 29-Apr-2024