diff --git a/.gitignore b/.gitignore index cef11d9b51..31a85243f2 100644 --- a/.gitignore +++ b/.gitignore @@ -28,8 +28,5 @@ config.yml server/tracetest.yaml server/html -# autogenerated with `cd cli; make docgen` -docs/docs/cli/reference/ - __debug* web/cypress/downloads diff --git a/docs/docs/cli/reference/cli-sidebar.js b/docs/docs/cli/reference/cli-sidebar.js new file mode 100644 index 0000000000..6cc0166223 --- /dev/null +++ b/docs/docs/cli/reference/cli-sidebar.js @@ -0,0 +1,97 @@ + +/** @type {import('@docusaurus/plugin-content-docs/lib/sidebars/types').SidebarItem[]} */ +const pages = [ + + { + type: "doc", + label: "tracetest", + id: "cli/reference/tracetest" + }, + { + type: "doc", + label: "tracetest apply", + id: "cli/reference/tracetest_apply" + }, + { + type: "doc", + label: "tracetest completion", + id: "cli/reference/tracetest_completion" + }, + { + type: "doc", + label: "tracetest completion bash", + id: "cli/reference/tracetest_completion_bash" + }, + { + type: "doc", + label: "tracetest completion fish", + id: "cli/reference/tracetest_completion_fish" + }, + { + type: "doc", + label: "tracetest completion powershell", + id: "cli/reference/tracetest_completion_powershell" + }, + { + type: "doc", + label: "tracetest completion zsh", + id: "cli/reference/tracetest_completion_zsh" + }, + { + type: "doc", + label: "tracetest configure", + id: "cli/reference/tracetest_configure" + }, + { + type: "doc", + label: "tracetest dashboard", + id: "cli/reference/tracetest_dashboard" + }, + { + type: "doc", + label: "tracetest delete", + id: "cli/reference/tracetest_delete" + }, + { + type: "doc", + label: "tracetest export", + id: "cli/reference/tracetest_export" + }, + { + type: "doc", + label: "tracetest get", + id: "cli/reference/tracetest_get" + }, + { + type: "doc", + label: "tracetest list", + id: "cli/reference/tracetest_list" + }, + { + type: "doc", + label: "tracetest run", + id: "cli/reference/tracetest_run" + }, + { + type: "doc", + label: "tracetest server", + id: "cli/reference/tracetest_server" + }, + { + type: "doc", + label: "tracetest server install", + id: "cli/reference/tracetest_server_install" + }, + { + type: "doc", + label: "tracetest start", + id: "cli/reference/tracetest_start" + }, + { + type: "doc", + label: "tracetest version", + id: "cli/reference/tracetest_version" + }, +] + +module.exports = pages; diff --git a/docs/docs/cli/reference/tracetest.md b/docs/docs/cli/reference/tracetest.md new file mode 100644 index 0000000000..3d05fe5dcd --- /dev/null +++ b/docs/docs/cli/reference/tracetest.md @@ -0,0 +1,35 @@ +# CLI Reference +## tracetest + +CLI to configure, install and execute tests on a Tracetest server + +### Synopsis + +CLI to configure, install and execute tests on a Tracetest server + +### Options + +``` + -c, --config string config file will be used by the CLI (default "config.yml") + -h, --help help for tracetest + -o, --output string output format [pretty|json|yaml] + -s, --server-url string server url + -v, --verbose display debug information +``` + +### SEE ALSO + +* [tracetest apply](tracetest_apply.md) - Apply resources +* [tracetest completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell +* [tracetest configure](tracetest_configure.md) - Configure your tracetest CLI +* [tracetest dashboard](tracetest_dashboard.md) - Opens the Tracetest Dashboard URL +* [tracetest delete](tracetest_delete.md) - Delete resources +* [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 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 + +###### Auto generated by spf13/cobra on 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_apply.md b/docs/docs/cli/reference/tracetest_apply.md new file mode 100644 index 0000000000..defcf1820a --- /dev/null +++ b/docs/docs/cli/reference/tracetest_apply.md @@ -0,0 +1,34 @@ +# CLI Reference +## tracetest apply + +Apply resources + +### Synopsis + +Apply (create/update) resources to your Tracetest server + +``` +tracetest apply analyzer|config|datastore|demo|env|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] +``` + +### Options + +``` + -f, --file string path to the definition file + -h, --help help for apply +``` + +### 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 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_completion.md b/docs/docs/cli/reference/tracetest_completion.md new file mode 100644 index 0000000000..91a16c514c --- /dev/null +++ b/docs/docs/cli/reference/tracetest_completion.md @@ -0,0 +1,35 @@ +# CLI Reference +## tracetest completion + +Generate the autocompletion script for the specified shell + +### Synopsis + +Generate the autocompletion script for tracetest for the specified shell. +See each sub-command's help for details on how to use the generated script. + + +### Options + +``` + -h, --help help for completion +``` + +### 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 +* [tracetest completion bash](tracetest_completion_bash.md) - Generate the autocompletion script for bash +* [tracetest completion fish](tracetest_completion_fish.md) - Generate the autocompletion script for fish +* [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 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_completion_bash.md b/docs/docs/cli/reference/tracetest_completion_bash.md new file mode 100644 index 0000000000..806fac2349 --- /dev/null +++ b/docs/docs/cli/reference/tracetest_completion_bash.md @@ -0,0 +1,54 @@ +# CLI Reference +## tracetest completion bash + +Generate the autocompletion script for bash + +### Synopsis + +Generate the autocompletion script for the bash shell. + +This script depends on the 'bash-completion' package. +If it is not installed already, you can install it via your OS's package manager. + +To load completions in your current shell session: + + source <(tracetest completion bash) + +To load completions for every new session, execute once: + +#### Linux: + + tracetest completion bash > /etc/bash_completion.d/tracetest + +#### macOS: + + tracetest completion bash > $(brew --prefix)/etc/bash_completion.d/tracetest + +You will need to start a new shell for this setup to take effect. + + +``` +tracetest completion bash +``` + +### Options + +``` + -h, --help help for bash + --no-descriptions disable completion descriptions +``` + +### 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 completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_completion_fish.md b/docs/docs/cli/reference/tracetest_completion_fish.md new file mode 100644 index 0000000000..e3881a6792 --- /dev/null +++ b/docs/docs/cli/reference/tracetest_completion_fish.md @@ -0,0 +1,45 @@ +# CLI Reference +## tracetest completion fish + +Generate the autocompletion script for fish + +### Synopsis + +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: + + tracetest completion fish | source + +To load completions for every new session, execute once: + + tracetest completion fish > ~/.config/fish/completions/tracetest.fish + +You will need to start a new shell for this setup to take effect. + + +``` +tracetest completion fish [flags] +``` + +### Options + +``` + -h, --help help for fish + --no-descriptions disable completion descriptions +``` + +### 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 completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_completion_powershell.md b/docs/docs/cli/reference/tracetest_completion_powershell.md new file mode 100644 index 0000000000..e31673470b --- /dev/null +++ b/docs/docs/cli/reference/tracetest_completion_powershell.md @@ -0,0 +1,42 @@ +# CLI Reference +## tracetest completion powershell + +Generate the autocompletion script for powershell + +### Synopsis + +Generate the autocompletion script for powershell. + +To load completions in your current shell session: + + tracetest completion powershell | Out-String | Invoke-Expression + +To load completions for every new session, add the output of the above command +to your powershell profile. + + +``` +tracetest completion powershell [flags] +``` + +### Options + +``` + -h, --help help for powershell + --no-descriptions disable completion descriptions +``` + +### 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 completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_completion_zsh.md b/docs/docs/cli/reference/tracetest_completion_zsh.md new file mode 100644 index 0000000000..3ffe3f75dd --- /dev/null +++ b/docs/docs/cli/reference/tracetest_completion_zsh.md @@ -0,0 +1,56 @@ +# CLI Reference +## tracetest completion zsh + +Generate the autocompletion script for zsh + +### Synopsis + +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once: + + echo "autoload -U compinit; compinit" >> ~/.zshrc + +To load completions in your current shell session: + + source <(tracetest completion zsh) + +To load completions for every new session, execute once: + +#### Linux: + + tracetest completion zsh > "${fpath[1]}/_tracetest" + +#### macOS: + + tracetest completion zsh > $(brew --prefix)/share/zsh/site-functions/_tracetest + +You will need to start a new shell for this setup to take effect. + + +``` +tracetest completion zsh [flags] +``` + +### Options + +``` + -h, --help help for zsh + --no-descriptions disable completion descriptions +``` + +### 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 completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell + +###### Auto generated by spf13/cobra on 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_configure.md b/docs/docs/cli/reference/tracetest_configure.md new file mode 100644 index 0000000000..1ed2db7cfd --- /dev/null +++ b/docs/docs/cli/reference/tracetest_configure.md @@ -0,0 +1,38 @@ +# CLI Reference +## tracetest configure + +Configure your tracetest CLI + +### Synopsis + +Configure your tracetest CLI + +``` +tracetest configure [flags] +``` + +### Options + +``` + --ci if cloud is used, don't ask for authentication + --environment string set environmentID, so the CLI won't ask you for it + -g, --global configuration will be saved in your home dir + -h, --help help for configure + --organization string set organizationID, so the CLI won't ask you for it + -t, --token string set authetication with token, so the CLI won't ask you for authentication +``` + +### 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 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_dashboard.md b/docs/docs/cli/reference/tracetest_dashboard.md new file mode 100644 index 0000000000..b1ee9d6b36 --- /dev/null +++ b/docs/docs/cli/reference/tracetest_dashboard.md @@ -0,0 +1,33 @@ +# CLI Reference +## tracetest dashboard + +Opens the Tracetest Dashboard URL + +### Synopsis + +Opens the Tracetest Dashboard URL + +``` +tracetest dashboard [flags] +``` + +### Options + +``` + -h, --help help for dashboard +``` + +### 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 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_delete.md b/docs/docs/cli/reference/tracetest_delete.md new file mode 100644 index 0000000000..d5201a4607 --- /dev/null +++ b/docs/docs/cli/reference/tracetest_delete.md @@ -0,0 +1,34 @@ +# CLI Reference +## tracetest delete + +Delete resources + +### Synopsis + +Delete resources from your Tracetest server + +``` +tracetest delete analyzer|config|datastore|demo|env|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] +``` + +### Options + +``` + -h, --help help for delete + --id string id of the resource to delete +``` + +### 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 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_export.md b/docs/docs/cli/reference/tracetest_export.md new file mode 100644 index 0000000000..9818b0a982 --- /dev/null +++ b/docs/docs/cli/reference/tracetest_export.md @@ -0,0 +1,35 @@ +# CLI Reference +## tracetest export + +Export resource + +### Synopsis + +Export a resource from your Tracetest server + +``` +tracetest export analyzer|config|datastore|demo|env|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] +``` + +### Options + +``` + -f, --file string file path with name where to export the resource (default "resource.yaml") + -h, --help help for export + --id string id of the resource to export +``` + +### 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 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_get.md b/docs/docs/cli/reference/tracetest_get.md new file mode 100644 index 0000000000..813b82bbe7 --- /dev/null +++ b/docs/docs/cli/reference/tracetest_get.md @@ -0,0 +1,34 @@ +# CLI Reference +## tracetest get + +Get resource + +### Synopsis + +Get a resource from your Tracetest server + +``` +tracetest get analyzer|config|datastore|demo|env|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] +``` + +### Options + +``` + -h, --help help for get + --id string id of the resource to get +``` + +### 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 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_list.md b/docs/docs/cli/reference/tracetest_list.md new file mode 100644 index 0000000000..75646efb88 --- /dev/null +++ b/docs/docs/cli/reference/tracetest_list.md @@ -0,0 +1,38 @@ +# CLI Reference +## tracetest list + +List resources + +### Synopsis + +List resources from your Tracetest server + +``` +tracetest list analyzer|config|datastore|demo|env|organization|pollingprofile|test|testrunner|testsuite|variableset [flags] +``` + +### Options + +``` + --all All + -h, --help help for list + --skip int32 Skip number + --sortBy string Sort by + --sortDirection string Sort direction (default "desc") + --take int32 Take number (default 20) +``` + +### 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 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_run.md b/docs/docs/cli/reference/tracetest_run.md new file mode 100644 index 0000000000..5c5d60ae54 --- /dev/null +++ b/docs/docs/cli/reference/tracetest_run.md @@ -0,0 +1,39 @@ +# CLI Reference +## tracetest run + +run resources + +### Synopsis + +run resources + +``` +tracetest run test|testsuite [flags] +``` + +### Options + +``` + -f, --file string path to the definition file + -h, --help help for run + --id string id of the resource to run + -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 + --vars string variable set file or ID to be used +``` + +### 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 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_server.md b/docs/docs/cli/reference/tracetest_server.md new file mode 100644 index 0000000000..d5d0f585b4 --- /dev/null +++ b/docs/docs/cli/reference/tracetest_server.md @@ -0,0 +1,34 @@ +# CLI Reference +## tracetest server + +Manage your tracetest server + +### Synopsis + +Manage your tracetest server + +``` +tracetest server [flags] +``` + +### Options + +``` + -h, --help help for server +``` + +### 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 +* [tracetest server install](tracetest_server_install.md) - Install a new Tracetest server + +###### Auto generated by spf13/cobra on 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_server_install.md b/docs/docs/cli/reference/tracetest_server_install.md new file mode 100644 index 0000000000..b6c6560484 --- /dev/null +++ b/docs/docs/cli/reference/tracetest_server_install.md @@ -0,0 +1,37 @@ +# CLI Reference +## tracetest server install + +Install a new Tracetest server + +### Synopsis + +Install a new Tracetest server + +``` +tracetest server install [flags] +``` + +### Options + +``` + -f, --force Overwrite existing files + -h, --help help for install + --kubernetes-context string Kubernetes context used to install Tracetest. It will be only used if 'run-environment' is set as 'kubernetes'. + --mode (with-demo|just-tracetest) Indicate the type of demo environment to be installed with Tracetest. It can be 'with-demo' or 'just-tracetest'. (default none) + --run-environment (docker|kubernetes) Type of environment were Tracetest will be installed. It can be 'docker' or 'kubernetes'. (default none) +``` + +### 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 server](tracetest_server.md) - Manage your tracetest server + +###### Auto generated by spf13/cobra on 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_start.md b/docs/docs/cli/reference/tracetest_start.md new file mode 100644 index 0000000000..617100c735 --- /dev/null +++ b/docs/docs/cli/reference/tracetest_start.md @@ -0,0 +1,40 @@ +# CLI Reference +## tracetest start + +Start Tracetest + +### Synopsis + +Start using Tracetest + +``` +tracetest start [flags] +``` + +### Options + +``` + --api-key string agent api key + -e, --endpoint string set the value for the endpoint, so the CLI won't ask for this value + --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 + +``` + -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 30-Jan-2024 diff --git a/docs/docs/cli/reference/tracetest_version.md b/docs/docs/cli/reference/tracetest_version.md new file mode 100644 index 0000000000..5ea77740d4 --- /dev/null +++ b/docs/docs/cli/reference/tracetest_version.md @@ -0,0 +1,33 @@ +# CLI Reference +## tracetest version + +Display this CLI tool version + +### Synopsis + +Display this CLI tool version + +``` +tracetest version [flags] +``` + +### Options + +``` + -h, --help help for version +``` + +### 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 30-Jan-2024 diff --git a/docs/package.json b/docs/package.json index c7d1aa91a0..df584f0b1f 100644 --- a/docs/package.json +++ b/docs/package.json @@ -4,9 +4,8 @@ "private": true, "scripts": { "docusaurus": "docusaurus", - "prestart": "cd ../cli; make docgen;", "start": "docusaurus start", - "prebuild": "cd ../cli; make docgen;", + "docgen": "cd ../cli; make docgen;", "build": "docusaurus build", "swizzle": "docusaurus swizzle", "deploy": "docusaurus deploy",