From 6dc4724fa26ff11bca7cd91f8a28f43b7ef1d8b5 Mon Sep 17 00:00:00 2001 From: Maycon Santos Date: Tue, 19 May 2026 15:57:01 +0200 Subject: [PATCH] Add short flags for CLI command options (#754) --- src/pages/get-started/cli.mdx | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/pages/get-started/cli.mdx b/src/pages/get-started/cli.mdx index cbd502f9..a67e40c5 100644 --- a/src/pages/get-started/cli.mdx +++ b/src/pages/get-started/cli.mdx @@ -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: