Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update cli reference #3981

Merged
merged 1 commit into from
Aug 22, 2024
Merged

docs: update cli reference #3981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/docs/cli/reference/tracetest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
5 changes: 3 additions & 2 deletions docs/docs/cli/reference/tracetest_apply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -24,11 +24,12 @@ 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
```

### SEE ALSO

* [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
3 changes: 2 additions & 1 deletion docs/docs/cli/reference/tracetest_completion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
3 changes: 2 additions & 1 deletion docs/docs/cli/reference/tracetest_completion_bash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,12 @@ 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
```

### SEE ALSO

* [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
3 changes: 2 additions & 1 deletion docs/docs/cli/reference/tracetest_completion_fish.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,12 @@ 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
```

### SEE ALSO

* [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
3 changes: 2 additions & 1 deletion docs/docs/cli/reference/tracetest_completion_powershell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,12 @@ 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
```

### SEE ALSO

* [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
3 changes: 2 additions & 1 deletion docs/docs/cli/reference/tracetest_completion_zsh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,12 @@ 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
```

### SEE ALSO

* [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
3 changes: 2 additions & 1 deletion docs/docs/cli/reference/tracetest_configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,12 @@ 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
```

### SEE ALSO

* [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
3 changes: 2 additions & 1 deletion docs/docs/cli/reference/tracetest_dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@ 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
```

### SEE ALSO

* [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
5 changes: 3 additions & 2 deletions docs/docs/cli/reference/tracetest_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -24,11 +24,12 @@ 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
```

### SEE ALSO

* [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
5 changes: 3 additions & 2 deletions docs/docs/cli/reference/tracetest_export.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -25,11 +25,12 @@ 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
```

### SEE ALSO

* [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
5 changes: 3 additions & 2 deletions docs/docs/cli/reference/tracetest_get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -24,11 +24,12 @@ 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
```

### SEE ALSO

* [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
5 changes: 3 additions & 2 deletions docs/docs/cli/reference/tracetest_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -28,11 +28,12 @@ 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
```

### SEE ALSO

* [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
5 changes: 3 additions & 2 deletions docs/docs/cli/reference/tracetest_run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -30,11 +30,12 @@ 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
```

### SEE ALSO

* [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
3 changes: 2 additions & 1 deletion docs/docs/cli/reference/tracetest_server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
3 changes: 2 additions & 1 deletion docs/docs/cli/reference/tracetest_server_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,12 @@ 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
```

### SEE ALSO

* [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
4 changes: 3 additions & 1 deletion docs/docs/cli/reference/tracetest_start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -30,11 +31,12 @@ 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
```

### SEE ALSO

* [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
3 changes: 2 additions & 1 deletion docs/docs/cli/reference/tracetest_version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@ 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
```

### SEE ALSO

* [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
3 changes: 2 additions & 1 deletion docs/docs/cli/reference/tracetest_wait.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,12 @@ 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
```

### SEE ALSO

* [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
Loading