https://github.com/tiaanduplessis/kill-port

❌ Kill the process running on given port
https://github.com/tiaanduplessis/kill-port

kill port process

Last synced: 2 months ago
JSON representation

❌ Kill the process running on given port

• Host: GitHub
• URL: https://github.com/tiaanduplessis/kill-port
• Owner: tiaanduplessis
• License: mit
• Created: 2017-04-08T10:38:08.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-06-14T12:22:22.000Z (7 months ago)
• Last Synced: 2024-09-09T16:17:54.874Z (4 months ago)
• Topics: kill, port, process
• Language: JavaScript
• Homepage:
• Size: 596 KB
• Stars: 512
• Watchers: 7
• Forks: 40
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-star - kill-port
• awesome - Kill-port

README

        


  



kill-port



  Kill process running on given port








  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  






## Table of Contents

- [Table of Contents](#table-of-contents)

- [Install](#install)

- [Usage](#usage)

- [API](#api)

- [CLI](#cli)

- [Contributing](#contributing)

- [License](#license)

## Install

With `npm`:

```sh

npm install --save kill-port

```

With `yarn`:

```sh

yarn add kill-port

```

With `pnpm`:

```sh

pnpm add kill-port

```

## Usage

```js

const kill = require('kill-port')

const http = require('http')

const port = 8080

const server = http.createServer((req, res) => {

  res.writeHead(200, {

    'Content-Type': 'text/plain'

  })

  res.end('Hi!')

})

server.listen(port, () => {

  setTimeout(() => {

    

    // Currently you can kill ports running on TCP or UDP protocols

    kill(port, 'tcp')

      .then(console.log)

      .catch(console.log)

  }, 1000)

})

```

## API

The module exports a single function that takes a port number as argument. It returns a promise.

## CLI

You can use `kill-port` as a global package.

Install the package globally:

```sh

$ npm install --global kill-port

# OR

$ yarn global add kill-port

```

Then:

```sh

$ kill-port --port 8080

# OR

$ kill-port 9000

# OR you can use UDP

$ kill-port 9000 --method udp

```

You can also kill multiple ports:

```sh

$ kill-port --port 8080,5000,3000

# OR

$ kill-port 9000 3000 5000

```

You can also use [npx](https://nodejs.dev/learn/the-npx-nodejs-package-runner) to `kill-port` without installing:

```sh

# Kill a single port

$ npx kill-port --port 8080

$ npx kill-port 8080

# Use UDP

$ npx kill-port 9000 --method udp

# Kill multiple ports

$ npx kill-port --port 8080,5000,3000

$ npx kill-port 9000 3000 5000

```

## Contributing

Got an idea for a new feature? Found a bug? Contributions are welcome! Please [open up an issue](https://github.com/tiaanduplessis/feature-flip/issues) or [make a pull request](https://makeapullrequest.com/).

## License

[MIT © Tiaan du Plessis](./LICENSE)