DOCUMENTATION
Detailed guide for the @sachinthapa572/killport CLI utility.
FEATURES
- Cross-platform support: Works natively on Windows, macOS, and Linux
- Simple CLI: Just run
killport <port> - Force kill by default: Reliably terminates processes
- Graceful options: Opt-in gentle termination
- Safety checks: Process ownership validation and reserved port warnings
INSTALLATION
Global Installation
# Using bun
bun install -g @sachinthapa572/killport
# Using npm
npm install -g @sachinthapa572/killport
# Using yarn
yarn global add @sachinthapa572/killport
No Installation (npx)
npx @sachinthapa572/killport 8080
USAGE
The CLI is available as both killport and the shorter alias
kp.
# Kill a single port
killport 8080
# Using alias
kp 8080
# Kill multiple ports
kp 8080 3000 5000
OPTIONS REFERENCE
| OPTION | SHORT | TYPE | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| --graceful | -g | boolean | false | Graceful kill (SIGTERM/no /F) |
| --dry-run | -d | boolean | false | Preview without killing |
| --verbose | -v | boolean | false | Show detailed output |
| --timeout | -t | number | 30000 | Timeout in ms |
EXAMPLES
Kill Development Servers
killport 3000 8080 5000
Graceful Termination
killport --graceful 8080
Preview (Dry Run)
killport -d -v 3000
DEVELOPMENT
Requires Bun >= 1.0.0
# Install dependencies
bun install
# Build the CLI
bun run build
# Run tests
bun test