CLI quick reference
This page is for the Linux FlowMesh client. Reading normal status usually doesn’t require root; changing settings requires root or an authorized operator. On OpenWrt, manage persistent settings through LuCI / UCI where possible.
View status
| Command | Purpose |
|---|---|
flowmesh status | Shows the status of this device and its peers; exit code is 0 only when Running |
flowmesh status --json | Shows machine-readable status, BackendState and Health |
flowmesh ip | Shows this device’s mesh IP address |
flowmesh ping --until-direct=false -c 3 100.64.0.2 | Probes the example peer, accepting direct or relayed responses |
flowmesh whois 100.64.0.2 | Shows node information for the example address |
flowmesh netcheck | Checks the current relay list and NAT characteristics |
flowmesh dns status | Shows the DNS configuration in effect |
flowmesh exit-node list | Lists available exit nodes |
flowmesh serve status | Shows background service sharing configuration |
flowmesh metrics print | Prints metrics in Prometheus format |
flowmesh bugreport | Generates a local diagnostic file; doesn’t upload it automatically |
Replace the example IP with the actual device address. Running means the engine is running; it doesn’t mean every peer and service port is reachable.
Connection and settings
| Command | Purpose |
|---|---|
sudo flowmesh down | Pauses the connection; keeps the login and settings |
sudo flowmesh up | Tries to reconnect; if non-default settings exist, you must provide the full parameters as prompted |
sudo flowmesh logout | Contacts the control server to log out the node, and restores default settings |
sudo flowmesh set --hostname=office-server | Changes the device name |
sudo flowmesh set --accept-routes=true | Accepts approved subnet routes |
sudo flowmesh set --accept-dns=false | Stops automatically taking over system DNS |
sudo flowmesh set --exit-node= | Stops using an exit node |
sudo flowmesh set --shields-up=true | Blocks incoming connections; keeps responses to connections this device initiates |
Connecting for the first time requires the control server address and valid credentials. For a complete example, see the Linux installation guide.
set changes only the options you give it. up requires you to explicitly keep all existing non-default options; up --reset restores any options you don’t give to their defaults. Don’t treat the three as equivalent.
Further diagnostics
flowmesh debug prefs
sudo flowmesh debug pathsdebug prefs is for checking the current settings, and debug paths shows peer paths and why they were chosen. Debug output may include information such as device addresses; review it before sharing.
Command success vs. service success
- By default,
flowmesh pingaims to establish a direct connection and may return a non-zero exit code when it only gets relayed responses. - For
flowmesh dns query, check the response body; don’t rely on the exit code alone to decide whether resolution succeeded. logoutmay fail when the control server is unreachable; in that case, don’t assume the server has revoked the device identity.- A successful
set --advertise-routesmeans the local advertisement setting was submitted; an admin still needs to approve it and the accessing devices need to accept the routes.
For complete steps, see Subnet routes, Exit nodes and Troubleshooting.