From 5b6fbc64d08f1e52256c49a9980377dcd51ed901 Mon Sep 17 00:00:00 2001 From: Jorge Padilla Date: Thu, 22 Aug 2024 15:34:08 -0500 Subject: [PATCH] docs: update cli reference (#3981) --- docs/docs/cli/reference/tracetest.md | 3 ++- docs/docs/cli/reference/tracetest_apply.md | 5 +++-- docs/docs/cli/reference/tracetest_completion.md | 3 ++- docs/docs/cli/reference/tracetest_completion_bash.md | 3 ++- docs/docs/cli/reference/tracetest_completion_fish.md | 3 ++- docs/docs/cli/reference/tracetest_completion_powershell.md | 3 ++- docs/docs/cli/reference/tracetest_completion_zsh.md | 3 ++- docs/docs/cli/reference/tracetest_configure.md | 3 ++- docs/docs/cli/reference/tracetest_dashboard.md | 3 ++- docs/docs/cli/reference/tracetest_delete.md | 5 +++-- docs/docs/cli/reference/tracetest_export.md | 5 +++-- docs/docs/cli/reference/tracetest_get.md | 5 +++-- docs/docs/cli/reference/tracetest_list.md | 5 +++-- docs/docs/cli/reference/tracetest_run.md | 5 +++-- docs/docs/cli/reference/tracetest_server.md | 3 ++- docs/docs/cli/reference/tracetest_server_install.md | 3 ++- docs/docs/cli/reference/tracetest_start.md | 4 +++- docs/docs/cli/reference/tracetest_version.md | 3 ++- docs/docs/cli/reference/tracetest_wait.md | 3 ++- 19 files changed, 45 insertions(+), 25 deletions(-) diff --git a/docs/docs/cli/reference/tracetest.md b/docs/docs/cli/reference/tracetest.md index 8723d8e887..f2b962a3c2 100644 --- a/docs/docs/cli/reference/tracetest.md +++ b/docs/docs/cli/reference/tracetest.md @@ -14,6 +14,7 @@ CLI to configure, install and execute tests on a Tracetest server -h, --help help for tracetest -o, --output string output format [pretty|json|yaml] -s, --server-url string server url + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -33,4 +34,4 @@ CLI to configure, install and execute tests on a Tracetest server * [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 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_apply.md b/docs/docs/cli/reference/tracetest_apply.md index a698c37c51..901e4d0398 100644 --- a/docs/docs/cli/reference/tracetest_apply.md +++ b/docs/docs/cli/reference/tracetest_apply.md @@ -8,7 +8,7 @@ Apply resources Apply (create/update) resources to your Tracetest server ``` -tracetest apply analyzer|config|datastore|demo|env|environment|environmenttoken|invite|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] +tracetest apply analyzer|config|datastore|demo|env|environment|environmenttoken|invite|monitor|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] ``` ### Options @@ -24,6 +24,7 @@ tracetest apply analyzer|config|datastore|demo|env|environment|environmenttoken| -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -31,4 +32,4 @@ tracetest apply analyzer|config|datastore|demo|env|environment|environmenttoken| * [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_completion.md b/docs/docs/cli/reference/tracetest_completion.md index 2b64439076..cdf78ce21b 100644 --- a/docs/docs/cli/reference/tracetest_completion.md +++ b/docs/docs/cli/reference/tracetest_completion.md @@ -21,6 +21,7 @@ See each sub-command's help for details on how to use the generated script. -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -32,4 +33,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 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_completion_bash.md b/docs/docs/cli/reference/tracetest_completion_bash.md index 1bf0c70c6f..5e4a990200 100644 --- a/docs/docs/cli/reference/tracetest_completion_bash.md +++ b/docs/docs/cli/reference/tracetest_completion_bash.md @@ -50,6 +50,7 @@ tracetest completion bash -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -57,4 +58,4 @@ tracetest completion bash * [tracetest completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_completion_fish.md b/docs/docs/cli/reference/tracetest_completion_fish.md index 84d13e3091..f2aa23b763 100644 --- a/docs/docs/cli/reference/tracetest_completion_fish.md +++ b/docs/docs/cli/reference/tracetest_completion_fish.md @@ -39,6 +39,7 @@ tracetest completion fish [flags] -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -46,4 +47,4 @@ tracetest completion fish [flags] * [tracetest completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_completion_powershell.md b/docs/docs/cli/reference/tracetest_completion_powershell.md index dfee5595b6..49fb5961a7 100644 --- a/docs/docs/cli/reference/tracetest_completion_powershell.md +++ b/docs/docs/cli/reference/tracetest_completion_powershell.md @@ -34,6 +34,7 @@ tracetest completion powershell [flags] -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -41,4 +42,4 @@ tracetest completion powershell [flags] * [tracetest completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_completion_zsh.md b/docs/docs/cli/reference/tracetest_completion_zsh.md index 671ad95a29..f2cdd1bbf5 100644 --- a/docs/docs/cli/reference/tracetest_completion_zsh.md +++ b/docs/docs/cli/reference/tracetest_completion_zsh.md @@ -54,6 +54,7 @@ tracetest completion zsh [flags] -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -61,4 +62,4 @@ tracetest completion zsh [flags] * [tracetest completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_configure.md b/docs/docs/cli/reference/tracetest_configure.md index 1fabac06b8..e548b63e44 100644 --- a/docs/docs/cli/reference/tracetest_configure.md +++ b/docs/docs/cli/reference/tracetest_configure.md @@ -28,6 +28,7 @@ tracetest configure [flags] -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -35,4 +36,4 @@ tracetest configure [flags] * [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_dashboard.md b/docs/docs/cli/reference/tracetest_dashboard.md index 3fdc977469..1feabb6098 100644 --- a/docs/docs/cli/reference/tracetest_dashboard.md +++ b/docs/docs/cli/reference/tracetest_dashboard.md @@ -23,6 +23,7 @@ tracetest dashboard [flags] -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -30,4 +31,4 @@ tracetest dashboard [flags] * [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_delete.md b/docs/docs/cli/reference/tracetest_delete.md index a290bb036c..ce5dd2152e 100644 --- a/docs/docs/cli/reference/tracetest_delete.md +++ b/docs/docs/cli/reference/tracetest_delete.md @@ -8,7 +8,7 @@ Delete resources Delete resources from your Tracetest server ``` -tracetest delete analyzer|config|datastore|demo|env|environment|environmenttoken|invite|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] +tracetest delete analyzer|config|datastore|demo|env|environment|environmenttoken|invite|monitor|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] ``` ### Options @@ -24,6 +24,7 @@ tracetest delete analyzer|config|datastore|demo|env|environment|environmenttoken -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -31,4 +32,4 @@ tracetest delete analyzer|config|datastore|demo|env|environment|environmenttoken * [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_export.md b/docs/docs/cli/reference/tracetest_export.md index c40f7f5333..9352aa65e4 100644 --- a/docs/docs/cli/reference/tracetest_export.md +++ b/docs/docs/cli/reference/tracetest_export.md @@ -8,7 +8,7 @@ Export resource Export a resource from your Tracetest server ``` -tracetest export analyzer|config|datastore|demo|env|environment|environmenttoken|invite|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] +tracetest export analyzer|config|datastore|demo|env|environment|environmenttoken|invite|monitor|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] ``` ### Options @@ -25,6 +25,7 @@ tracetest export analyzer|config|datastore|demo|env|environment|environmenttoken -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -32,4 +33,4 @@ tracetest export analyzer|config|datastore|demo|env|environment|environmenttoken * [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_get.md b/docs/docs/cli/reference/tracetest_get.md index afc49245b3..01d7ffb465 100644 --- a/docs/docs/cli/reference/tracetest_get.md +++ b/docs/docs/cli/reference/tracetest_get.md @@ -8,7 +8,7 @@ Get resource Get a resource from your Tracetest server ``` -tracetest get analyzer|config|datastore|demo|env|environment|environmenttoken|invite|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] +tracetest get analyzer|config|datastore|demo|env|environment|environmenttoken|invite|monitor|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] ``` ### Options @@ -24,6 +24,7 @@ tracetest get analyzer|config|datastore|demo|env|environment|environmenttoken|in -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -31,4 +32,4 @@ tracetest get analyzer|config|datastore|demo|env|environment|environmenttoken|in * [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_list.md b/docs/docs/cli/reference/tracetest_list.md index fdaabf35cc..99d2f29e9e 100644 --- a/docs/docs/cli/reference/tracetest_list.md +++ b/docs/docs/cli/reference/tracetest_list.md @@ -8,7 +8,7 @@ List resources List resources from your Tracetest server ``` -tracetest list analyzer|config|datastore|demo|env|environment|environmenttoken|invite|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] +tracetest list analyzer|config|datastore|demo|env|environment|environmenttoken|invite|monitor|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] ``` ### Options @@ -28,6 +28,7 @@ tracetest list analyzer|config|datastore|demo|env|environment|environmenttoken|i -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -35,4 +36,4 @@ tracetest list analyzer|config|datastore|demo|env|environment|environmenttoken|i * [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_run.md b/docs/docs/cli/reference/tracetest_run.md index a14a26b0c1..549904b381 100644 --- a/docs/docs/cli/reference/tracetest_run.md +++ b/docs/docs/cli/reference/tracetest_run.md @@ -8,7 +8,7 @@ Run tests and test suites Run tests and test suites ``` -tracetest run [test|testsuite] [flags] +tracetest run [testsuite|test] [flags] ``` ### Options @@ -30,6 +30,7 @@ tracetest run [test|testsuite] [flags] -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -37,4 +38,4 @@ tracetest run [test|testsuite] [flags] * [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_server.md b/docs/docs/cli/reference/tracetest_server.md index b2e00ebf69..33b306b40d 100644 --- a/docs/docs/cli/reference/tracetest_server.md +++ b/docs/docs/cli/reference/tracetest_server.md @@ -23,6 +23,7 @@ tracetest server [flags] -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -31,4 +32,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 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_server_install.md b/docs/docs/cli/reference/tracetest_server_install.md index 0ec3ca8249..7a0af1a06d 100644 --- a/docs/docs/cli/reference/tracetest_server_install.md +++ b/docs/docs/cli/reference/tracetest_server_install.md @@ -27,6 +27,7 @@ tracetest server install [flags] -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -34,4 +35,4 @@ tracetest server install [flags] * [tracetest server](tracetest_server.md) - Manage your tracetest server -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_start.md b/docs/docs/cli/reference/tracetest_start.md index 4978c99a7d..a381c17a97 100644 --- a/docs/docs/cli/reference/tracetest_start.md +++ b/docs/docs/cli/reference/tracetest_start.md @@ -18,6 +18,7 @@ tracetest start [flags] --collector-endpoint string address of the OTel Collector endpoint --environment string environment id -h, --help help for start + --insecure allow insecure connections to control plane -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 @@ -30,6 +31,7 @@ tracetest start [flags] -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -37,4 +39,4 @@ tracetest start [flags] * [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_version.md b/docs/docs/cli/reference/tracetest_version.md index 9493821b11..4e484dcddf 100644 --- a/docs/docs/cli/reference/tracetest_version.md +++ b/docs/docs/cli/reference/tracetest_version.md @@ -23,6 +23,7 @@ tracetest version [flags] -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -30,4 +31,4 @@ tracetest version [flags] * [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024 diff --git a/docs/docs/cli/reference/tracetest_wait.md b/docs/docs/cli/reference/tracetest_wait.md index 9d393c7db8..b6a890864b 100644 --- a/docs/docs/cli/reference/tracetest_wait.md +++ b/docs/docs/cli/reference/tracetest_wait.md @@ -24,6 +24,7 @@ tracetest wait group [flags] -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 + --skip-verify skip verification of the server certificate (allows self signed, for example) -v, --verbose display debug information ``` @@ -31,4 +32,4 @@ tracetest wait group [flags] * [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server -###### Auto generated by spf13/cobra on 24-May-2024 +###### Auto generated by spf13/cobra on 22-Aug-2024