Welcome to Port Keeper Wiki 🚀

Port Keeper is a comprehensive port management tool for developers that helps reserve, monitor, and manage local development ports through both CLI and GUI interfaces.

🌟 Key Features

• Port Reservation System: Reserve ports for specific projects to prevent conflicts
• Process Management: Kill processes occupying ports with a single command
• Active Port Scanning: Detect all ports currently in use with process information
• Multi-Port Requests: Automatically find and reserve multiple available ports
• Export/Import: Share port configurations with your team
• Cross-Platform: Works on macOS, Linux, and Windows
• GUI Interface: Visual dashboard for managing ports (optional)
• AI Integration: Built-in documentation for AI agents and automation

🚀 Quick Links

• Installation Guide - Get started with Port Keeper
• CLI Reference - Complete command documentation
• GUI User Guide - Visual interface documentation
• API Documentation - Integration and automation
• Troubleshooting - Common issues and solutions
• Best Practices - Tips for effective port management

📦 Installation

# Install globally via npm
npm install -g portkeeper

# If you encounter NODE_MODULE_VERSION error:
npm rebuild -g better-sqlite3

🎯 Quick Start

Check if a port is available

portman check 3000

Reserve a port for your project

portman reserve 3000 --name "my-app" --desc "React dev server"

List all managed ports

portman list

Launch the GUI

portman gui

🤝 Community

• GitHub: ahmadzein/portkeeper
• npm: portkeeper
• Website: portkeeper.net | portkeeper.dev
• Issues: Report bugs
• Discussions: Join the conversation

📚 Documentation Structure

Getting Started

• Installation - Installation methods and requirements
• Quick Start Guide - Get up and running in minutes
• Configuration - Customize Port Keeper settings

CLI Documentation

• CLI Reference - All commands and options
• CLI Examples - Real-world usage examples
• Shell Integration - Aliases and completions

GUI Documentation

• GUI User Guide - Complete visual interface guide
• Keyboard Shortcuts - Productivity shortcuts
• Themes and Customization - Personalize your experience

Advanced Topics

• API Documentation - Programmatic usage
• AI Integration Guide - Automation with AI agents
• Team Collaboration - Sharing configurations
• Database Schema - Understanding data storage

Development

• Contributing - How to contribute
• Architecture - System design and structure
• Building from Source - Development setup

💡 Why Port Keeper?

Managing ports during development can be challenging:

• Port Conflicts: Multiple projects competing for the same ports
• Team Coordination: Different developers using different ports
• Process Management: Orphaned processes blocking ports
• Documentation: No central record of port assignments

Port Keeper solves these problems by providing a centralized port management system with both CLI and GUI interfaces.

🛡️ License

Port Keeper is released under the MIT License. See LICENSE for details.

---

Happy port managing! 🚢