summaryrefslogtreecommitdiffstats
path: root/cli/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 02:57:58 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 02:57:58 +0000
commitbe1c7e50e1e8809ea56f2c9d472eccd8ffd73a97 (patch)
tree9754ff1ca740f6346cf8483ec915d4054bc5da2d /cli/README.md
parentInitial commit. (diff)
downloadnetdata-be1c7e50e1e8809ea56f2c9d472eccd8ffd73a97.tar.xz
netdata-be1c7e50e1e8809ea56f2c9d472eccd8ffd73a97.zip
Adding upstream version 1.44.3.upstream/1.44.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'cli/README.md')
-rw-r--r--cli/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/cli/README.md b/cli/README.md
new file mode 100644
index 00000000..8dd9cce8
--- /dev/null
+++ b/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/daemon/README.md#command-line-options).
+
+