Skip to content

Commit bda6337

Browse files
committed
Status bage added
1 parent 557081c commit bda6337

File tree

1 file changed

+8
-16
lines changed

1 file changed

+8
-16
lines changed

README.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
55
*Because repetitive tasks shouldn't be boring...*
66

7+
**Unittests status for Win/Lin/Mac environments:** [![Python Multi-OS Tests](https://github.com/Dimos082/cli-monitor/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/Dimos082/cli-monitor/actions/workflows/test.yml)
78

89
<details>
910
<summary>📖 Table of Contents</summary>
@@ -14,16 +15,13 @@
1415
- [Example Commands](#example-commands)
1516
- [Arguments Overview](#arguments-overview)
1617
- [Contributing](#contributing)
17-
- [Issues & Feature Requests](#issues--feature-requests)
1818
- [License](#license)
1919
</details>
2020

2121
## Overview
2222

2323
CLI Monitor is designed to help automate command execution, log outputs, and monitor for specific patterns using **regex**. If a match is found, the tool can execute an additional command. It handles logging, error reporting, and summary generation with ease.
2424

25-
[🔼 Back to top](#cli-monitor-️)
26-
2725
## Features
2826

2927
- **Flexible Command Execution**: Run any CLI command at a chosen frequency.
@@ -32,9 +30,8 @@ CLI Monitor is designed to help automate command execution, log outputs, and mon
3230
- **Auto-Stop Timer**: Set a duration for execution or let it run indefinitely.
3331
- **Cross-Platform Compatibility**: Works on Windows, Linux, and macOS with Python 3.
3432

35-
[🔼 Back to top](#cli-monitor-️)
3633

37-
## Quick Start
34+
## ▶️ Quick Start
3835

3936
1. **Download** [cli_monitor.py](https://raw.githubusercontent.com/Dimos082/cli-monitor/refs/heads/main/cli_monitor.py).
4037
2. **Run with an argument**:
@@ -58,7 +55,7 @@ Termination Reason: Manual termination by user
5855

5956
[🔼 Back to top](#cli-monitor-️)
6057

61-
## Example Commands
58+
## 🎛️ Example Commands
6259

6360
### Process Monitoring (babysit/watchdog mode)
6461

@@ -80,7 +77,7 @@ python cli_monitor.py --command "echo Hello" --frequency 3
8077

8178
Prints "Hello" every 3 seconds.
8279

83-
### Log File Management
80+
### Log File Management
8481

8582
```bash
8683
python cli_monitor.py --command "ls -la" --output-file "/tmp/mylog.txt" --max-log-size 50
@@ -101,7 +98,7 @@ Runs for 10 seconds, searching for "error" or "fail" and executing an alert comm
10198

10299
[🔼 Back to top](#cli-monitor-️)
103100

104-
## Arguments Overview
101+
## 💬 Arguments Overview
105102

106103
| Argument | Required? | Default | Description |
107104
|-----------------|:---------:|--------:|-------------|
@@ -117,7 +114,7 @@ Runs for 10 seconds, searching for "error" or "fail" and executing an alert comm
117114

118115
## 🛠️ Contributing
119116

120-
We welcome contributions to make CLI Monitor even better! If you have an idea for an improvement, feel free to:
117+
We welcome contributions to make CLI Monitor even better! If you have an idea for an improvement or new [test cases](https://github.com/Dimos082/cli-monitor/tree/main/tests), feel free to:
121118

122119
- **Fork the repository**
123120
- **Create a new feature branch**:
@@ -127,18 +124,13 @@ We welcome contributions to make CLI Monitor even better! If you have an idea fo
127124
- **Push your changes**: `git push origin feature/NewFeature`
128125
- **Open a pull request** 🐈‍⬛
129126

130-
If you find a bug or have a feature request, check out our [open issues](https://github.com/Dimos082/cli-monitor/issues) or create a new one. Your feedback is valuable!
127+
If you find a bug or have a feature request, check out [open issues](https://github.com/Dimos082/cli-monitor/issues) or create a new one. Your feedback is valuable!
131128

132129
If you find [cli_monitor.py](https://raw.githubusercontent.com/Dimos082/cli-monitor/refs/heads/main/cli_monitor.py) useful, consider giving it a ⭐ on GitHub!
133130

134-
[🔼 Back to top](#cli-monitor-️)
135-
136-
## Issues & Feature Requests
137-
138-
Have an issue or an idea? Visit the [issue tracker](https://github.com/Dimos082/cli-monitor/issues) to report bugs, suggest enhancements, or discuss improvements.
139131

140132
## 📜 License
141133

142134
This project is licensed under the Apache 2.0 - see the [LICENSE](https://github.com/Dimos082/cli-monitor?tab=Apache-2.0-1-ov-file) file for details.
143135

144-
[🔼 Back to top](#cli-monitor-️)
136+
[🔼 Back to top](#cli-monitor-️)

0 commit comments

Comments
 (0)