npm

Join us for the upcoming webinar, "Enterprise JavaScript done right: the tools you love, the security you need."Sign up here »

tasklist

4.0.0 • Public • Published

tasklist Build Status

Wrapper for the Windows tasklist command. Returns a list of apps and services with their Process ID (PID) for all tasks running on either a local or a remote computer.

Cleans up and normalizes the data.

Install

$ npm install tasklist

Usage

const tasklist = require('tasklist');
 
(async () => {
    console.log(await tasklist());
    /*
    [{
        imageName: 'taskhostex.exe',
        pid: 1820,
        sessionName: 'Console',
        sessionNumber: 1,
        memUsage: 4415488
    }, …]
    */
})();

API

See the tasklist docs for more.

tasklist(options?)

Returns a Promise<Array> with running tasks.

options

Type: object

The system, username, password options must be specified together.

verbose

Type: boolean
Default: false

Return verbose results.

Without the verbose option, taskkill returns tasks with the following properties:

  • imageName (Type: string)
  • pid (Type: number)
  • sessionName (Type: string)
  • sessionNumber (Type: number)
  • memUsage in bytes (Type: number)

With the verbose option set to true, it additionally returns the following properties:

  • status (Type: string): One of Running, Suspended, Not Responding, or Unknown
  • username (Type: string)
  • cpuTime in seconds (Type: number)
  • windowTitle (Type: string)

Note: It's not guaranteed that the username and windowTitle properties are returned with proper values. If they are not available, 'N/A' may be returned on English systems. In contrast, 'Nicht zutreffend' may be returned on German systems, for example.

Verbose example:

const tasklist = require('tasklist');
 
(async () => {
    console.log(await tasklist({verbose: true}));
    /*
    [{
        imageName: 'taskhostex.exe',
        pid: 1820,
        sessionName: 'Console',
        sessionNumber: 1,
        memUsage: 4415488,
        status: 'Running',
        username: 'SINDRESORHU3930\\sindre'
        cpuTime: 0,
        windowTitle: 'Task Host Window'
    }, …]
    */
})();

Warning: Using the verbose option may have a considerable performance impact (See: #6).

system

Type: string

Name or IP address of a remote computer (don't use backslashes). The default is the local computer.

username

Type: string
Example: SINDRESORHU3930\\sindre

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: array

Specify the types of processes to include or exclude. More info.

Related

  • taskkill - Wrapper for the Windows taskkill command

Maintainers

install

npm i tasklist

Downloadsweekly downloads

90,798

version

4.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability