Update debug cli (#213)

This commit is contained in:
Viktor Liu
2024-08-12 13:07:04 +02:00
committed by GitHub
parent b225b0626f
commit 0e7aa8c09d

View File

@@ -464,7 +464,7 @@ The file is only accessible as root/Administrator.
#### Usage
To create a debug bundle:
```shell
netbird debug bundle -A
netbird debug bundle [-A] [-S]
```
#### Examples
@@ -482,6 +482,7 @@ This will output:
```shell
-h, --help help for bundle
-A, --anonymize anonymize IP addresses and non-netbird.io domains in the debug output
-S, --system-info Adds system information to the debug bundle
```
### debug for
@@ -491,31 +492,34 @@ This is useful for capturing detailed logs over a period where issues are occurr
#### Usage
To run debugging for a specific time period:
```shell
netbird debug for <time> -A
netbird debug for <time> [-A] [-S]
```
#### Examples
Run debugging for 5 minutes and generate a debug bundle:
Run debugging for 5 minutes and generate an anonymized debug bundle:
```shell
netbird debug for 5m
```
This will output:
This will output something similar to:
```
Netbird down
Netbird up
Log level set to trace.
Netbird down
Netbird up
Remaining time: 00:00:01
Duration completed
Netbird down
Creating debug bundle...
/tmp/netbird.debug.2180993458.zip
Netbird down
Log level restored to INFO
/tmp/netbird.debug.3162242909.zip
```
#### Flags
```shell
-h, --help help for for
-A, --anonymize anonymize IP addresses and non-netbird.io domains in the debug output
-h, --help help for for
-A, --anonymize anonymize IP addresses and non-netbird.io domains in the debug output
-S, --system-info Adds system information to the debug bundle
```