https://github.com/trusted97/healthcli
https://github.com/trusted97/healthcli
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/trusted97/healthcli
- Owner: Trusted97
- License: mit
- Created: 2024-12-04T09:14:08.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-23T10:48:10.000Z (about 1 year ago)
- Last Synced: 2025-04-23T11:36:36.599Z (about 1 year ago)
- Language: Rust
- Size: 305 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚑 HealthCLI
Manage and perform health checks for your system with style and simplicity!
## 🌟 Features
* 🔍 Run health checks for your system components.
* 📝 Register new health checks tailored to your needs.
* 📋 List all registered health checks.
* 🔧 Flexible filters by name or type.
## 🚀 Installation
1. Clone the repository:
`git clone https://github.com/Trusted97/healthcli.git`
2. Build the project:
`cargo build --release`
3. Run the binary:
`./target/release/healthcli`
### 📖 Usage
HealthCLI provides three main commands: `check`, `register`, and `list`.
### 1\. Run Health Checks (`check`)
Run all health checks, or filter by name or type:
healthcli check \[OPTIONS\]
#### Options:
* `-n, --name `: Run a specific health check by its name.
* `-t, --check-type `: Run checks of a specific type (e.g., `url`, `database`, `disk`).
#### Examples:
* Run all checks: `healthcli check`
* Run a specific check: `healthcli check --name "Ping Google"`
* Run checks of type `url`: `healthcli check --check-type url`
### 2\. Register New Health Checks (`register`)
Add a new health check:
``` bash
healthcli register --name --check-type
```
#### Examples:
* Register a new URL check:
``` bash
healthcli register --name "Ping Google" --check-type url
```
* Register a disk space check:
``` bash
healthcli register --name "Check Disk Space" --check-type disk
```
### 3\. List All Registered Checks (`list`)
Display all registered health checks: `healthcli list`
## 🤝 Contributing
We welcome contributions to improve HealthCLI! Feel free to submit issues or pull requests to make this tool even better. 💪
## 📜 License
This project is licensed under the [MIT License](LICENSE).