/KumaCompanion

KumaCompanion is a CLI to manage uptime-kuma

Primary LanguagePythonMIT LicenseMIT

KumaCompanion

Typing SVG

CLI for managing Uptime Kuma.
Explore the docs »

View Demo · Report Bug · Request Feature



About

KumaCompanion is a powerful and flexible Command-Line Interface (CLI) tool for managing and interacting with Uptime Kuma, a feature-rich monitoring platform. With KumaCompanion, you can easily configure, monitor, and manage your applications, services, and infrastructure seamlessly from the command line.

Note: This project is currently under development and may be incomplete.

Roadmap

  • Commands: kuma monitor
    • add
    • delete
    • edit
    • ls
    • get
    • pause
    • resume
  • Commands : kuma maintenance
    • add
    • delete
    • edit
    • ls
    • get
  • Commands : kuma status
    • add
    • delete
    • edit
    • ls
    • get
  • Commands : kuma label
    • add
    • delete
    • edit
    • ls
    • get
  • Docs: Write all documentations
  • Build: Create system package
  • Docker: Create container for commands
    • Image: Create image
    • Deploy: Push image on docker hub

You can watch the Open Issues for a full list of features (and known issues).

(back to top)

✍️ Contributors