https://github.com/erdemkosk/network-pocket

This is cli tool for sniffing your network and monitor to rx and tx packages from network.
https://github.com/erdemkosk/network-pocket

cli nodejs npm tool

Last synced: 3 months ago
JSON representation

This is cli tool for sniffing your network and monitor to rx and tx packages from network.

• Host: GitHub
• URL: https://github.com/erdemkosk/network-pocket
• Owner: erdemkosk
• Created: 2021-08-25T11:59:27.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-28T21:39:11.000Z (over 2 years ago)
• Last Synced: 2025-02-07T14:14:57.716Z (over 1 year ago)
• Topics: cli, nodejs, npm, tool
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/network-pocket
• Size: 69.3 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Network Pocket

 ![Logo](https://imgur.com/huejlyk.gif)

## Overview

The `network-pocket` is a command-line tool built with Node.js. It provides real-time monitoring of network statistics, including download and upload speeds, network interface information, and update notifications.

## Features

- **Real-time Monitoring**: Constantly displays download and upload speeds in a graphical ASCII chart.

- **Network Interface Details**: Shows details about the default network interface such as IP address, MAC address, and type.

- **Status Notifications**: Provides status notifications when the network state changes.

- **Update Notifications**: Alerts the user about available updates for the tool.

## Dependencies

- `systeminformation`: Fetches system and network information.

- `asciichart`: Generates ASCII charts for visual representation.

- `chalk`: Adds color styles to the console output.

- `update-notifier`: Checks for updates and notifies the user.

- `boxen`: Creates a colored box for update notifications.

- `beeper`: Generates system beeps for notifications.

- `cli-cursor`: Manages the visibility of the cursor in the command line interface.

## Functionality

The tool initializes by fetching default network interface information and starts continuously monitoring network statistics using `systeminformation`. The key functionalities include:

- **Graphical Representation**: Utilizes `asciichart` to create graphical representations of download and upload speeds in real-time.

- **Network Interface Display**: Presents detailed information about the default network interface including IP address, MAC address, and type.

- **Status Updates**: Notifies the user of changes in network status (e.g., "up" or "down") and triggers system beeps for attention.

- **Update Alerts**: Utilizes `update-notifier` to check for available updates and displays notifications when updates are available.

## Usage

1. Install the tool: `npm install -g network-pocket`

2. Run the tool in the terminal: `network-pocket`

## Future Improvements

- Adding additional statistical metrics.

- Enhancing user interface for better interaction.

- Supporting more customization options.

-------