#监控 #socket-io #自动化 #uptime-kuma #api #命令行 #命令行界面

app kuma-cli

用于管理和与 Uptime Kuma 交互的 CLI 工具

5 个版本 (重大更改)

0.8.0 2024 年 8 月 22 日
0.7.0 2024 年 7 月 15 日
0.6.0 2024 年 4 月 28 日
0.5.0 2024 年 4 月 13 日
0.0.3 2024 年 4 月 2 日

#4#socket-io

MIT 许可证

175KB
4K SLoC

Kuma CLI 🤖 Crates.io 版本

Kuma CLI 是一个用于管理和与 Uptime Kuma 交互的命令行界面 (CLI) 工具。使用 Kuma CLI,您可以从命令行轻松配置、监控和管理应用程序。

特性 🎯

  • 命令:kuma monitor
    • 添加
    • 删除
    • 编辑
    • 列表
    • 获取
    • 暂停
    • 恢复
  • 命令:kuma tag
    • 添加
    • 删除
    • 编辑
    • 列出
    • 获取
  • 命令:kuma notification
    • 添加
    • 删除
    • 编辑
    • 列出
    • 获取
  • 命令:kuma maintenance
    • 添加
    • 删除
    • 编辑
    • 列出
    • 获取
    • 暂停
    • 恢复
  • 命令:kuma status-page
    • 添加
    • 删除
    • 编辑
    • 列出
    • 获取
  • 命令:kuma docker-host
    • 添加
    • 删除
    • 编辑
    • 列出
    • 获取
    • 测试

如何安装 📦

提供 Windows、Linux 和 Mac OS 的二进制文件,可在 GitHub 发布 中找到,并且可以使用 cargo 安装 Kuma CLI

cargo install --git https://github.com/BigBoot/AutoKuma.git kuma-cli

使用 💡

Usage: kuma [OPTIONS] [COMMAND]

Commands:
  monitor       Manage Monitors
  notification  Manage Notifications
  tag           Manage Tags
  maintenanc    Manage Maintenances
  help          Print this message or the help of the given subcommand(s)

Options:
      --url <URL>
          The URL AutoKuma should use to connect to Uptime Kuma
      --username <USERNAME>
          The username for logging into Uptime Kuma (required unless auth is disabled)
      --password <PASSWORD>
          The password for logging into Uptime Kuma (required unless auth is disabled)
      --mfa-token <MFA_TOKEN>
          The MFA token for logging into Uptime Kuma (required if MFA is enabled)
      --header <KEY=VALUE>
          Add a HTTP header when connecting to Uptime Kuma
      --connect-timeout <CONNECT_TIMEOUT>
          The timeout for the initial connection to Uptime Kuma [default: 30.0]
      --call-timeout <CALL_TIMEOUT>
          The timeout for executing calls to the Uptime Kuma server [default: 30.0]
      --format <OUTPUT_FORMAT>
          The output format [default: json] [possible values: json, toml, yaml]
      --pretty
          Wether the output should be pretty printed or condensed
  -h, --help
          Print help
  -V, --version
          Print version

配置 🔧

所有配置选项也可以作为环境变量指定

KUMA__URL="https://127.0.0.1:3001/"
KUMA__USERNAME="<username>"
KUMA__PASSWORD="<password>"
...

此外,Kuma CLI 将从当前目录和以下位置读取配置文件 kuma.{toml,yaml,json}

平台 示例
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

一个示例 .toml 配置可能如下所示

url = "https://127.0.0.1:3001/"
username = "<username>"
password = "<password>"

依赖项

~532MB
~16M SLoC