Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kiapanahi/net-monitor
Net-Monitor is a simple command-line interface (CLI) application built in Go that monitors all network interfaces on your computer and displays the upload and download speeds for each interface in real-time.
https://github.com/kiapanahi/net-monitor
cli go golang gopsutil monitoring network pet-project system-monitoring
Last synced: 1 day ago
JSON representation
Net-Monitor is a simple command-line interface (CLI) application built in Go that monitors all network interfaces on your computer and displays the upload and download speeds for each interface in real-time.
- Host: GitHub
- URL: https://github.com/kiapanahi/net-monitor
- Owner: kiapanahi
- License: mit
- Created: 2024-08-29T19:19:18.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-29T20:02:52.000Z (3 months ago)
- Last Synced: 2024-08-29T21:54:50.746Z (3 months ago)
- Topics: cli, go, golang, gopsutil, monitoring, network, pet-project, system-monitoring
- Language: Go
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Net Monitor
Net Monitor is a simple CLI tool to monitor network interfaces activity. It provides real-time statistics on network usage.
## Table of Contents
- [Net Monitor](#net-monitor)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Commands](#commands)
- [`monitor`](#monitor)
- [Development](#development)
- [Prerequisites](#prerequisites)
- [Running the Project](#running-the-project)
- [Project Structure](#project-structure)
- [Dependencies](#dependencies)
- [License](#license)
## Installation
To build the project, you need to have Go installed. Clone the repository and run the following command to build the executable:
On Windows:
```powershell
go build -o bin/nm.exe
```
On Linux/Unix:
```bash
go build -o bin/nd
```
Alternatively, you can use the provided VS Code task to build the project:
Open the Command Palette (Ctrl+Shift+P).
Select Tasks: Run Build Task.
## Usage
After building the project, you can run the executable to start monitoring network interfaces:
`nm monitor`
## Commands
### `monitor`
The `monitor` command starts monitoring network interfaces and displays real-time statistics.
## Development
### Prerequisites
- Go 1.23.0 or higher
- VS Code (optional, but recommended)
### Running the Project
To run the project using VS Code, you can use the provided launch configuration:
1. Open the Command Palette (Ctrl+Shift+P).
2. Select Debug: Start Debugging.
This will start the `monitor` command.
### Project Structure
- `cmd/`: Contains the CLI commands.
- `monitor.go`: Implements the monitor command.
- `root.go`: Defines the root command and initializes subcommands.
- `main.go`: Entry point of the application.
## Dependencies
The project uses the following dependencies:
`github.com/shirou/gopsutil`: For fetching network statistics.
`github.com/spf13/cobra`: For building the CLI.
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.