Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zingerlittlebee/netop
Network Top -- Help you monitor network traffic with bpf
https://github.com/zingerlittlebee/netop
cli network rust terminal traffic
Last synced: about 2 hours ago
JSON representation
Network Top -- Help you monitor network traffic with bpf
- Host: GitHub
- URL: https://github.com/zingerlittlebee/netop
- Owner: ZingerLittleBee
- License: mit
- Created: 2022-05-28T08:32:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T14:07:27.000Z (28 days ago)
- Last Synced: 2024-10-29T21:59:13.338Z (19 days ago)
- Topics: cli, network, rust, terminal, traffic
- Language: Rust
- Homepage: https://crates.io/crates/netop
- Size: 2.27 MB
- Stars: 174
- Watchers: 2
- Forks: 7
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Language : 🇺🇸 English | [🇨🇳 简体中文](./README.zh-CN.md)
netop
[](https://hub.docker.com/r/zingerbee/netop)
[](https://hub.docker.com/r/zingerbee/netop/tags)
[](https://hub.docker.com/r/zingerbee/netop/tags)
[](https://github.com/ZingerLittleBee/netop/actions)
[](https://github.com/ZingerLittleBee/netop/commits/main)
[](./LICENSE)
## Overview
`netop` is a terminal command line interface that can customize the filter **network traffic** rule 🎯
### Features
- Use the `bpf` rule filter
- Multi-rule switching
- Real-time rate
- Total traffic
- Response UI
- Resource occupation is small, `rust` Written
- Support `docker` deployment
## Installation
### Docker
```bash
docker run -it --rm --net=host zingerbee/netop
```
### Cargo
need `rust` and `pcap`, detail look at [How to build](#How-to-build-from-source)
```bash
# install
sudo cargo install netop
# and then run
netop
# or designated network interface card running
netop -n eth0
```
### NetBSD
On NetBSD there's an official package available.
To install a pre-compiled binary, simply run
```bash
pkgin install netop
```
Or, if you prefer to build it from source,
```bash
cd /usr/pkgsrc/net/netop
make install
```
### Arch Linux
[AUR](https://aur.archlinux.org/packages/netop)
> Thanks to @kemelzaidan for the contribution!
## How to use
- Press `e` to **enter edit mode** input [bpf rule](https://biot.com/capstats/bpf.html), and then press `enter`
- Press `Esc` to **exit edit mode**
- Use the `<-` or `->` to switch between different rules
- Not in edit mode, press `dd` to delete current rule
- Not in edit mode, press `q` to quit
### View help
```bash
netop -h
# docker
docker run -it --rm --net=host zingerbee/netop -h
```
Output as follows
```bash
netop 0.1.4
USAGE:
netop [OPTIONS]
OPTIONS:
-h, --help Print help information
-n, --name Name of Network Interface Card
-V, --version Print version information
```
### Designated network interface card running
> The parameter is **name of network interface card**
>
> *unix: Use `ifconfig` to view network interface cards information
>
> windows: Use `ipconfig` to view network interface cards information
```bash
netop -n eth0
# docker
docker run -it --rm --net=host zingerbee/netop -n eth0
```
## How to build from source
Development environment
- It is best to be `root` user, `pcap` requires permissions
- `rust` >= 1.40.0
- `pcap`
- Ubuntu、Debian: `apt install libpcap-dev`
- MacOS: installed by default
- Windows: Download the [WinPcap](https://www.winpcap.org/install/default.htm) Developer's Pack. Add the /Lib or /Lib/x64 folder to your LIB environment variable.
```bash
sudo cargo install --path .
# or
sudo cargo run
```
## Found an issue or have a proposal
[Create an issue](https://github.com/ZingerLittleBee/netop/issues)
## Release Notes
SEE [CHANGELOG](./CHANGELOG.md)