Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qharny/portzap
PortZap: Cross-platform CLI Port Killer PortZap is a lightweight, efficient Dart CLI tool designed to terminate processes running on specified ports. Compatible with Windows, macOS, and Linux, it's the perfect utility for developers who need to quickly free up ports during development or debugging.
https://github.com/qharny/portzap
cli dart
Last synced: 13 days ago
JSON representation
PortZap: Cross-platform CLI Port Killer PortZap is a lightweight, efficient Dart CLI tool designed to terminate processes running on specified ports. Compatible with Windows, macOS, and Linux, it's the perfect utility for developers who need to quickly free up ports during development or debugging.
- Host: GitHub
- URL: https://github.com/qharny/portzap
- Owner: Qharny
- Created: 2024-07-22T12:32:13.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-22T19:39:22.000Z (4 months ago)
- Last Synced: 2024-07-23T15:08:00.776Z (4 months ago)
- Topics: cli, dart
- Language: Dart
- Homepage:
- Size: 10.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# PortZap 🚀⚡
PortZap is a command-line utility written in Dart that helps you manage and terminate processes running on specific ports. It's cross-platform, supporting Windows, macOS, and Linux.
## Features
- List all running ports and their associated process IDs
- Kill a process running on a specific port
- Cross-platform support (Windows, macOS, Linux)
## Installation
1. Ensure you have Dart SDK installed on your system.
2. Clone this repository or download the `portzap.dart` file.
3. Run `dart pub get` to install dependencies.
## Usage
```
dart run bin/portzap.dart [-p | -l] [-h]
```
### Options:
- `-p, --port`: Specify the port number to kill the process on
- `-l, --list`: List all running ports and their associated PIDs
- `-h, --help`: Show usage information
### Examples:
1. List all running ports:
```
dart run bin/portzap.dart -l
```
2. Kill a process running on port 8080:
```
dart run bin/portzap.dart -p 8080
```
3. Show help information:
```
dart run bin/portzap.dart -h
```
## How it works
1. **Parsing arguments**: The script uses the `args` package to parse command-line arguments, allowing users to specify options like port number, listing ports, or showing help.
2. **Listing ports**:
- On Windows: Uses `netstat -ano` to list all TCP/IP network connections and their associated processes.
- On macOS/Linux: Uses `lsof -i -P -n` to list open files and network connections.
The output is then parsed to extract port numbers and process IDs.
3. **Killing a process on a specific port**:
- First, it identifies the process ID (PID) associated with the given port:
- On Windows: Uses `netstat -ano | findstr :`
- On macOS/Linux: Uses `lsof -i : -t`
- Then, it terminates the process using the appropriate command:
- On Windows: `taskkill /F /PID `
- On macOS/Linux: `kill -9 `
4. **Error handling**: The script includes error handling to manage issues like invalid input, unsupported platforms, or failed operations.
## Notes
- This tool requires appropriate permissions to list and terminate processes. On some systems, you may need to run it with elevated privileges (e.g., using `sudo` on macOS/Linux).
- Always use caution when terminating processes, especially on production systems.
## Contributing
Contributions, issues, and feature requests are welcome. Feel free to check [issues page](link_to_issues) if you want to contribute.
## License
[MIT License](link_to_license)