https://github.com/sindresorhus/taskkill
Wrapper for the Windows `taskkill` command. Ends one or more tasks or processes.
https://github.com/sindresorhus/taskkill
Last synced: 1 day ago
JSON representation
Wrapper for the Windows `taskkill` command. Ends one or more tasks or processes.
- Host: GitHub
- URL: https://github.com/sindresorhus/taskkill
- Owner: sindresorhus
- License: mit
- Created: 2015-05-31T00:10:29.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2022-06-24T13:07:14.000Z (over 2 years ago)
- Last Synced: 2025-02-13T12:13:57.627Z (8 days ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 40
- Watchers: 8
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# taskkill
> Wrapper for the Windows [`taskkill`](https://technet.microsoft.com/en-us/library/bb491009.aspx) command. Ends one or more tasks or processes.
## Install
```sh
npm install taskkill
```
## Usage
```js
import {taskkill} from 'taskkill';
await taskkill([pid, pid2]);
```
## API
See the [`taskkill` docs](https://technet.microsoft.com/en-us/library/bb491009.aspx) for more.
### taskkill(input, options?)
Kill asynchronously.
Returns a `Promise`.
### taskkillSync(input, options?)
Kill synchronously.
### Arguments
#### input
Type: `string | number | string[] | number[]`
One or more process IDs or image names, but not mixed.
#### options
The `system`, `username`, `password` options are mutually inclusive.
##### system
Type: `string`
Name or IP address of a remote computer (do not use backslashes). The default is the local computer.
##### username
Type: `string`
A user specified by `User` or `Domain\User`.
The default is the permissions of the current logged on user on the computer issuing the command.
##### password
Type: `string`
Password of the user account for the specified `username`.
##### filter
Type: `string`
Types of processes to include or exclude from termination.
See the [`taskkill` docs](https://technet.microsoft.com/en-us/library/bb491009.aspx) for supported filters.
##### force
Type: `boolean`
Forcefully terminate processes. Ignored for remote processes as all remote processes are forcefully terminated.
##### tree
Type: `boolean`
Terminate all child processes along with the parent process, commonly known as a tree kill.
## Related
- [tasklist](https://github.com/sindresorhus/tasklist) - Wrapper for the Windows `tasklist` command
- [fkill](https://github.com/sindresorhus/fkill) - Force kill processes, cross-platform