antop
| Crates.io | antop |
| lib.rs | antop |
| version | 0.2.2 |
| created_at | 2025-04-06 01:57:57.812944+00 |
| updated_at | 2025-04-07 20:29:16.016527+00 |
| description | A TUI application for monitoring antnode instances. Discovers nodes via log files, fetches metrics (resource usage, peers, bandwidth, etc.), calculates network speeds, and displays the information in a terminal dashboard with sparklines. |
| homepage | |
| repository | |
| max_upload_size | |
| id | 1622577 |
| size | 226,986 |
(Champii)
documentation
README
Antop
A terminal dashboard for monitoring Autonomi node instances.
Features
- Automatic Discovery: Finds running
antnodeinstances by scanning log files (configurable path). - Real-time Metrics: Fetches and displays key metrics from discovered nodes.
- TUI Dashboard: Presents information clearly in your terminal using
ratatui.
Installation
Prerequisites
- Rust (stable toolchain)
From Crates.io (recommended)
cargo install antop
From Source
- Clone the repository:
git clone https://github.com/champii/antop.git cd antop - Build the release binary:
cargo build --release - The executable will be located at
target/release/antop.
Usage
-
Run the application:
antopOr, if installed via source:
cargo run -
Node Discovery:
- By default,
antoplooks for node root directories in~/.local/share/autonomi/node/*to find information like storage paths. Use--pathto override this. - It also scans for log files using the pattern
~/.local/share/autonomi/node/*/logs/antnode.logto discover metrics server addresses. - You can override the node directory discovery path using the
--pathoption:
antop --path "/path/to/your/nodes/node-*"- You can override the log file discovery path using the
--log-pathoption with a glob pattern matching the specific log files:
antop --log-path "/custom/log/location/node-*/antnode.log" - By default,
License
This project is licensed under the MIT License. See the LICENSE file for details.