Update CLI flags and reorder pages

netbirdio · Feb 23, 2024 · c0a5819 · c0a5819
1 parent a168bf2
commit c0a5819
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 7 deletions.
diff --git a/src/components/NavigationDocs.jsx b/src/components/NavigationDocs.jsx
@@ -58,13 +58,13 @@ export const docsNavigation = [
             { title: 'Activity event streaming', href: '/how-to/activity-event-streaming' },
             { title: 'Access NetBird API', href: '/how-to/access-netbird-public-api' },
             { title: 'Running NetBird on FaaS', href: '/how-to/netbird-on-faas' },
-            { title: 'Examples', href: '/how-to/examples' },
-            { title: 'CLI', href: '/how-to/cli' },
             { title: 'Delete your NetBird account', href: '/how-to/delete-account' },
-            { title: 'IdP sync', href: '/how-to/idp-sync' },
             { title: 'Manage access with posture checks', href: '/how-to/manage-posture-checks' },
             { title: 'Report bugs and issues', href: '/how-to/report-bug-issues' },
             { title: 'Troubleshooting client issues', href: '/how-to/troubleshooting-client' },
+            { title: 'Examples', href: '/how-to/examples' },
+            { title: 'CLI', href: '/how-to/cli' },
+            { title: 'IdP sync', href: '/how-to/idp-sync' },
         ],
     },
     {

diff --git a/src/pages/how-to/cli.mdx b/src/pages/how-to/cli.mdx
@@ -54,10 +54,16 @@ Single command to log in and start the NetBird client. It can send a signal to t
 The command will check if the peer is logged in and connect to the management service. If the peer is not logged in, by default, it will attempt to initiate an SSO login flow.
 #### Flags
 ```shell
+      --allow-server-ssh              Allow SSH server on peer. If enabled, the SSH server will be permitted
+      --disable-auto-connect          Disables auto-connect feature. If enabled, then the client won't connect automatically when the service starts.
       --dns-resolver-address string   Sets a custom address for NetBird's local DNS resolver. If set, the agent won't attempt to discover the best ip and port to listen on. An empty string "" clears the previous configuration. E.g. --dns-resolver-address 127.0.0.1:5053 or --dns-resolver-address ""
+      --enable-rosenpass              [Experimental] Enable Rosenpass feature. If enabled, the connection will be post-quantum secured via Rosenpass.
       --external-ip-map strings       Sets external IPs maps between local addresses and interfaces.You can specify a comma-separated list with a single IP and IP/IP or IP/Interface Name. An empty string "" clears the previous configuration. E.g. --external-ip-map 12.34.56.78/10.0.0.1 or --external-ip-map 12.34.56.200,12.34.56.78/10.0.0.1,12.34.56.80/eth1 or --external-ip-map ""
   -F, --foreground-mode               start service in foreground
-
+  -h, --help                          help for up
+      --interface-name string         Wireguard interface name (default "utun100")
+      --rosenpass-permissive          [Experimental] Enable Rosenpass in permissive mode to allow this peer to accept WireGuard connections without requiring Rosenpass functionality from peers that do not have Rosenpass enabled.
+      --wireguard-port uint16         Wireguard interface listening port (default 51820)
 ```
 #### Usage
 The minimal form of running the command is:
@@ -112,9 +118,14 @@ netbird down
 Retrieves the peer status from the daemon service.
 #### Flags
 ```shell
-  -d, --detail                    display detailed status information
-      --filter-by-ips strings     filters the detailed output by a list of one or more IPs, e.g. --filter-by-ips 100.64.0.100,100.64.0.200
-      --filter-by-status string   filters the detailed output by connection status(connected|disconnected), e.g. --filter-by-status connected
+  -d, --detail                    display detailed status information in human-readable format
+      --filter-by-ips strings     filters the detailed output by a list of one or more IPs, e.g., --filter-by-ips 100.64.0.100,100.64.0.200
+      --filter-by-names strings   filters 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   filters the detailed output by connection status(connected|disconnected), e.g., --filter-by-status connected
+  -h, --help                      help for status
+      --ipv4                      display only NetBird IPv4 of this peer, e.g., --ipv4 will output 100.64.0.33
+      --json                      display detailed status information in json format
+      --yaml                      display detailed status information in yaml format
 ```
 #### Usage
 The minimal form of running the command is: