Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/tasklist
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.
https://github.com/sindresorhus/tasklist
Last synced: about 1 month ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/sindresorhus/tasklist
- Owner: sindresorhus
- License: mit
- Created: 2015-05-30T23:36:58.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2021-08-12T12:08:18.000Z (over 3 years ago)
- Last Synced: 2024-04-14T00:32:08.632Z (7 months ago)
- Language: JavaScript
- Size: 33.2 KB
- Stars: 64
- Watchers: 10
- Forks: 18
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# tasklist
> Wrapper for the Windows [`tasklist`](https://technet.microsoft.com/en-us/library/bb491010.aspx) 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
```js
import {tasklist} from 'tasklist';
console.log(await tasklist());
/*
[
{
imageName: 'taskhostex.exe',
pid: 1820,
sessionName: 'Console',
sessionNumber: 1,
memUsage: 4415488
},
…
]
*/
```
## API
See the [`tasklist` docs](https://technet.microsoft.com/en-us/library/bb491010.aspx) for more.
### tasklist(options?)
Returns a `Promise` that contains the normalized results of the command output.
Examples for `options` below will use this interface, but you can check `tasklist.stream` below for usage of the stream interface.
### tasklistStream(options?)
Returns a `stream.Readable` that returns the resulting lines, normalized, one-by-one.
Options are the same as the Promise interface.
```js
import {tasklistStream} from 'tasklist';
tasklistStream({verbose: true}).pipe(process.stdout);
/*
{
imageName: 'taskhostex.exe',
pid: 1820,
sessionName: 'Console',
sessionNumber: 1,
memUsage: 4415488,
status: 'Running',
username: 'SINDRESORHU3930\\sindre'
cpuTime: 0,
windowTitle: 'Task Host Window'
}
…
*/
```
#### options
Type: `object`
**Warning**
- The `system`, `username`, `password` options must be specified together.
- The `modules` and `services` options can't be specified if verbose is set to `true`.
- The `modules` and `services` options can't be specified at the same time.
- When `system`, `username`, `password` options are specified, the filter option can't have `windowtitle` and `status` as the parameter.
##### verbose
Type: `boolean`\
Default: `false`
Return verbose results.
Without the `verbose` and `apps` option, `tasklist` 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` but the `apps` option still set to `false`, 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:**
```js
import {tasklist} from 'tasklist';
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](https://github.com/sindresorhus/tasklist/issues/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: `string[]`
Specify the types of processes to include or exclude. [More info.](https://technet.microsoft.com/en-us/library/bb491010.aspx)
##### apps
Type: `boolean`
Displays store apps.
Without the `verbose` option, the command returns the following data:
- `imageName` (Type: `string`)
- `pid` (Type: `number`)
- `memUsage` in bytes (Type: `number`)
- `packageName` (Type: `string`)
```js
import {tasklist} from 'tasklist';
console.log(await tasklist({apps: true}));
/*
[
{
imageName: 'SearchUI.exe (CortanaUI)',
pid: 1820,
memUsage: 4415488,
packageName: 'Microsoft.Windows.Cortana'
},
…
]
*/
```
With the `verbose` option set to `true`, the command additionally returns the following data:
- `sessionName` (Type: `string`)
- `sessionNumber` (Type: `number`)
- `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:**
```js
import {tasklist} from 'tasklist';
console.log(await tasklist({apps: true, verbose: true}));
/*
[
{
imageName: 'SearchUI.exe (CortanaUI)',
pid: 1820,
sessionName: 'Console',
sessionNumber: 1,
memUsage: 4415488,
status: 'Running',
username: 'SINDRESORHU3930\\sindre'
cpuTime: 0,
windowTitle: 'N/A',
packageName: 'Microsoft.Windows.Cortana'
},
…
]
*/
```
##### modules
Type: `string`
List all tasks using the given DLL module name. If an empty string is given, it will list all tasks with the used DLL modules.
**Note:** You can't use the `verbose` option with this option set.
```js
import {tasklist} from 'tasklist';
console.log(await tasklist({modules: 'wmiutils.dll'}));
/*
[{
imageName: 'chrome.exe',
pid: 1820,
modules: ['wmiutils.dll']
}, …]
*/
```
##### services
Type: `boolean`
Displays services hosted in each process.
**Note:** You can't use the `verbose` option with this option set.
```js
import {tasklist} from 'tasklist';
console.log(await tasklist({services: true}));
/*
[{
imageName: 'lsass.exe',
pid: 856,
services: ['KeyIso', 'SamSs', 'VaultSvc']
}, …]
*/
```
## Related
- [taskkill](https://github.com/sindresorhus/taskkill) - Wrapper for the Windows `taskkill` command
## Maintainers
- [Sindre Sorhus](https://sindresorhus.com)
- [Mark Tiedemann](https://marksweb.site)