diff options
Diffstat (limited to '')
| -rw-r--r-- | src/cli/README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/src/cli/README.md b/src/cli/README.md new file mode 100644 index 000000000..682bee892 --- /dev/null +++ b/src/cli/README.md @@ -0,0 +1,38 @@ +# Netdata Agent CLI + +The `netdatacli` executable provides a simple way to control the Netdata agent's operation. + +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`. + +The commands that a running netdata agent can execute are the following: + +```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. +``` + +See also the Netdata daemon [command line options](https://github.com/netdata/netdata/blob/master/src/daemon/README.md#command-line-options). + + |