kuma-cli-0.6.0 is not a library.
Kuma CLI
Kuma CLI is a Command Line Interface (CLI) tool for managing and interacting with Uptime Kuma. With Kuma CLI you can easily configure, monitor and manage your applications from the command line.
Features
- Commands:
kuma monitor
-
add
-
delete
-
edit
-
list
-
get
-
pause
-
resume
-
- Commands :
kuma tag
-
add
-
delete
-
edit
-
ls
-
get
-
- Commands :
kuma notification
-
add
-
delete
-
edit
-
ls
-
get
-
- Commands :
kuma maintenance
-
add
-
delete
-
edit
-
ls
-
get
-
pause
-
resume
-
- Commands :
kuma status-page
-
add
-
delete
-
edit
-
ls
-
get
-
- Commands :
kuma docker-host
-
add
-
delete
-
edit
-
ls
-
get
-
test
-
🔧 How to Install
Binaries for Windows, Linux and Mac OS are provided for GitHub Releases and additionally Kuma CLI can be installed using cargo
:
Usage
)
)
)
)
Configuration
All configuration options can also be specified as environment variables:
KUMA__URL="http://localhost:3001/"
KUMA__USERNAME="<username>"
KUMA__PASSWORD="<password>"
...
Additionally Kuma CLI will read configuration from a file named kuma.{toml,yaml,json}
in the current directory and in the following locations:
Platform | Value | Example |
---|---|---|
Linux | $XDG_CONFIG_HOME /kuma/config.{toml,yaml,json} |
/home/alice/.config/kuma/config.toml |
macOS | $HOME /Library/Application Support/kuma/config.{toml,yaml,json} |
/Users/Alice/Library/Application Support/kuma/config.toml |
Windows | %LocalAppData% \\kuma\\config.{toml,yaml,json} |
C:\\Users\\Alice\\AppData\\Local\\kuma\\config.toml |
An example .toml
config could look like the following:
= "http://localhost:3001/"
= "<username>"
= "<password>"