Skip to content

Wrapper for the Windows `taskkill` command. Ends one or more tasks or processes.

License

Notifications You must be signed in to change notification settings

sindresorhus/taskkill

Repository files navigation

taskkill

Wrapper for the Windows taskkill command. Ends one or more tasks or processes.

Install

npm install taskkill

Usage

import {taskkill} from 'taskkill';

await taskkill([pid, pid2]);

API

See the taskkill docs 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 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 - Wrapper for the Windows tasklist command
  • fkill - Force kill processes, cross-platform