sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-08-25 01:01:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add short flags for CLI command options (#754)

Browse Source
This commit is contained in:
Maycon Santos
2026-05-19 15:57:01 +02:00
committed by GitHub
parent 84a3532943
commit 6dc4724fa2
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/pages/get-started/cli.mdx
View File

@@ -186,16 +186,16 @@ netbird down
Retrieves the peer status from the daemon service.
#### Flags
```shell
--check string Run a health check and exit with code 0 on success, 1 on failure (live|ready|startup)
-C, --check string Run a health check and exit with code 0 on success, 1 on failure (live|ready|startup)
-d, --detail Display detailed status information in human-readable format
--filter-by-connection-type string Filter the detailed output by connection type (P2P|Relayed), e.g., --filter-by-connection-type P2P
--filter-by-ips strings Filter the detailed output by a list of one or more IPs (v4 or v6), e.g., --filter-by-ips 100.64.0.100,fd00::1
--filter-by-names strings Filter the detailed output by a list of one or more peer FQDN or hostnames, e.g., --filter-by-names peer-a,peer-b.netbird.cloud
--filter-by-status string Filter the detailed output by connection status (idle|connecting|connected), e.g., --filter-by-status connected
--ipv4 Display only NetBird IPv4 of this peer, e.g., --ipv4 will output 100.64.0.33
--ipv6 Display only NetBird IPv6 of this peer
--json Display detailed status information in JSON format
--yaml Display detailed status information in YAML format
-t, --filter-by-connection-type string Filter the detailed output by connection type (P2P|Relayed), e.g., --filter-by-connection-type P2P
-i, --filter-by-ips strings Filter the detailed output by a list of one or more IPs (v4 or v6), e.g., --filter-by-ips 100.64.0.100,fd00::1
-N, --filter-by-names strings Filter the detailed output by a list of one or more peer FQDN or hostnames, e.g., --filter-by-names peer-a,peer-b.netbird.cloud
-S, --filter-by-status string Filter the detailed output by connection status (idle|connecting|connected), e.g., --filter-by-status connected
-4, --ipv4 Display only NetBird IPv4 of this peer, e.g., --ipv4 will output 100.64.0.33
-6, --ipv6 Display only NetBird IPv6 of this peer
-j, --json Display detailed status information in JSON format
-y, --yaml Display detailed status information in YAML format
```
#### Usage
The minimal form of running the command is: