diff options
Diffstat (limited to 'src/cli/README.md')
| -rw-r--r-- | src/cli/README.md | 48 |
1 files changed, 17 insertions, 31 deletions
diff --git a/src/cli/README.md b/src/cli/README.md index 29c75d450..b990f4775 100644 --- a/src/cli/README.md +++ b/src/cli/README.md @@ -1,38 +1,24 @@ # Netdata Agent CLI -The `netdatacli` executable provides a simple way to control the Netdata agent's operation. +The `netdatacli` executable offers a straightforward way to manage the Netdata Agent's operations. -You can see the commands `netdatacli` supports by executing it with `netdatacli` and entering `help` in -standard input. All commands are given as standard input to `netdatacli`. +It is located in the same directory as the `netdata` binary. -The commands that a running netdata agent can execute are the following: +Available commands: -```sh -The commands are (arguments are in brackets): -help - Show this help menu. -reload-health - Reload health configuration. -reload-labels - Reload all labels. -save-database - Save internal DB to disk for database mode save. -reopen-logs - Close and reopen log files. -shutdown-agent - Cleanup and exit the netdata agent. -fatal-agent - Log the state and halt the netdata agent. -reload-claiming-state - Reload agent claiming state from disk. -ping - Return with 'pong' if agent is alive. -aclk-state [json] - Returns current state of ACLK and Cloud connection. (optionally in json) -dumpconfig - Returns the current netdata.conf on stdout. -``` +| Command | Description | +|------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `help` | Display usage information and exit. | +| `reload-health` | Reloads the Netdata health configuration, updating alerts based on changes made to configuration files. | +| `reload-labels` | Reloads [host labels](/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts.md#custom-labels) from netdata.conf. | +| `reopen-logs` | Close and reopen log files. | +| `shutdown-agent` | Gracefully shut down the Netdata Agent. | +| `fatal-agent` | Log the current state and forcefully halt the Netdata Agent. | +| `reload-claiming-state` | Reload the Agent's claiming state from disk. | +| `ping` | Checks the Agent's status. If the Agent is alive, it exits with status code 0 and prints 'pong' to standard output. Exits with status code 255 otherwise. | +| `aclk-state [json]` | Return the current state of ACLK and Cloud connection. Optionally in JSON. | +| `dumpconfig` | Display the current netdata.conf configuration. | +| `remove-stale-node <node_id \| machine_guid \| hostname \| ALL_NODES>` | Un-registers a stale child Node, removing it from the parent Node's UI and Netdata Cloud. This is useful for ephemeral Nodes that may stop streaming and remain visible as stale. | +| `version` | Display the Netdata Agent version. | See also the Netdata daemon [command line options](/src/daemon/README.md#command-line-options). - - |