Skip to content

Commit 5bef8b6

Browse files
committed
docs: refresh README install guide
1 parent 528e885 commit 5bef8b6

1 file changed

Lines changed: 37 additions & 25 deletions

File tree

README.md

Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,59 @@
11
# kill-port-process-cli ![npm downloads](https://img.shields.io/npm/dt/kill-port-process-cli)
22

3-
A CLI tool to kill processes by port. This tool allows you to terminate processes running on specified ports. It is useful for developers who need to quickly free up ports during development.
3+
A CLI tool to kill processes by port. It helps quickly free occupied ports during local development.
44

55
## Install
66

7-
```bash
8-
npm install kill-port-process-cli
9-
```
10-
## Global Install
7+
### npm
8+
119
```bash
1210
npm install -g kill-port-process-cli
1311
```
14-
## Homebrew Install
15-
Install from the dedicated tap:
12+
13+
### Homebrew
14+
15+
Tap repository: [luckfunc/homebrew-tap](https://github.com/luckfunc/homebrew-tap)
1616

1717
```bash
1818
brew tap luckfunc/tap
1919
brew install kill-port-process-cli
2020
```
21-
### Usage
22-
You can use the tool by running the `k` or `k-p` or `kill-port` command followed by one or more port numbers.
23-
### Recommended Command
24-
We recommend using the `k` command for simplicity and ease of use.
25-
### example
26-
To kill processes running on ports 3000 and 3001:
21+
22+
## Commands
23+
24+
Available commands:
25+
26+
- `kill-port`
27+
- `k-p`
28+
- `k`
29+
30+
Recommended command:
31+
2732
```bash
2833
k 3000 3001
2934
```
30-
or
35+
36+
Equivalent commands:
37+
3138
```bash
3239
k-p 3000 3001
33-
```
34-
or
35-
```bash
3640
kill-port 3000 3001
3741
```
38-
### Compatibility
42+
43+
## Compatibility
44+
3945
This tool is compatible with Windows, macOS, and Linux.
40-
### How It Works
46+
47+
## How It Works
48+
4149
1. The tool identifies the process ID (PID) using the specified port.
42-
2. It then terminates the process associated with that PID.
43-
### Finding the PID
44-
- On Unix-based systems, it uses the `lsof` command.
45-
- On Windows, it uses the `netstat` command.
46-
### Contributing
47-
Contributions are welcome! Please open an issue or submit a pull request.
50+
2. It terminates the process associated with that PID.
51+
52+
### PID Lookup
53+
54+
- On Unix-based systems, it uses `lsof`.
55+
- On Windows, it uses `netstat`.
56+
57+
## Contributing
58+
59+
Contributions are welcome. Please open an issue or submit a pull request.

0 commit comments

Comments
 (0)