Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/owloops/updo
Uptime monitoring CLI tool with alerting and advanced settings
https://github.com/owloops/updo
cli monitoring termui
Last synced: 9 days ago
JSON representation
Uptime monitoring CLI tool with alerting and advanced settings
- Host: GitHub
- URL: https://github.com/owloops/updo
- Owner: Owloops
- License: mit
- Created: 2023-12-26T13:01:30.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-05-11T07:55:10.000Z (6 months ago)
- Last Synced: 2024-05-11T08:47:23.061Z (6 months ago)
- Topics: cli, monitoring, termui
- Language: Go
- Homepage:
- Size: 8.23 MB
- Stars: 133
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-readme - Owloops/updo - Well-structured, visually appealing, and provides comprehensive information about the tool, from its purpose and features to installation and usage, in a clear and user-friendly manner. (Examples)
- awesome-readme - Owloops/updo - Well-structured, visually appealing, and provides comprehensive information about the tool, from its purpose and features to installation and usage, in a clear and user-friendly manner. (Examples)
README
# 🐤 Updo - Website Monitoring Tool
Updo is a command-line tool for monitoring website uptime and performance. It provides real-time metrics on website status, response time, SSL certificate expiry, and more, with alert notifications.
[](https://github.com/Owloops/updo/releases/latest)
## Features
- Real-time monitoring of website uptime and performance
- Displays various metrics like uptime percentage, average response time, and SSL certificate expiry
- Desktop alert notifications for website status changes
- Customizable refresh intervals and request timeouts
- Supports HTTP and HTTPS, with options to skip SSL verification
- Assertion on response body content
## Demo
https://github.com/Owloops/updo/assets/17541283/5edd2eb1-af81-4b88-96e2-643c80d46aca
## Installation
Download executable binaries
#### You can download executable binaries from the latest release page:
> [](https://github.com/Owloops/updo/releases/latest)
Build from source
#### You can install Updo by cloning the repository and building the binary:
Make sure your system has Go [installed](https://go.dev/doc/install).
> ```bash
> git clone https://github.com/Owloops/updo.git
> cd updo
> go build
> ```
#### Another way to install it if you have go in your machine just:
```sh
GOBIN="absolute_path_where_you_want_binaries_to_be_installed" go install github.com/Owloops/updo@latest
```
> [!NOTE]
> You may get a warning message on Windows and MacOS, which is discussed in this issue https://github.com/Owloops/updo/issues/4
## Usage
Run Updo using the following command:
```bash
./updo [options] --url
```
### Docker
You can run Updo using Docker:
```
docker build -t updo .
docker run -it updo [options] --url
```
### Options
- `--url`: URL of the website to monitor (required)
- `--refresh`: Refresh interval in seconds (default: 5)
- `--should-fail`: Invert status code success (default: false)
- `--timeout`: HTTP request timeout in seconds (default: 10)
- `--follow-redirects`: Follow redirects (default: true)
- `--skip-ssl`: Skip SSL certificate verification (default: false)
- `--assert-text`: Text to assert in the response body
- `--receive-alert`: Enable alert notifications (default: true)
- `--help`: Display help message
### Example
```bash
./updo --refresh=10 --should-fail=false --url https://example.com
```
## Keyboard Shortcuts
- `q` or `Ctrl+C`: Quit the application
## Mentions
- [awesome-readme](https://github.com/matiassingers/awesome-readme)
- [termui](https://github.com/gizak/termui)
- [Terminal Trove](https://terminaltrove.com/updo)
## Contributing
Contributions to Updo are welcome! Feel free to create issues or submit pull requests.
## License
This project is licensed under the [MIT License](LICENSE).