https://github.com/sindresorhus/ps-list

Get running processes
https://github.com/sindresorhus/ps-list

Last synced: about 1 month ago
JSON representation

Get running processes

• Host: GitHub
• URL: https://github.com/sindresorhus/ps-list
• Owner: sindresorhus
• License: mit
• Created: 2015-05-31T00:52:31.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2022-12-26T11:47:38.000Z (almost 2 years ago)
• Last Synced: 2024-05-19T14:30:40.152Z (6 months ago)
• Language: JavaScript
• Size: 331 KB
• Stars: 265
• Watchers: 9
• Forks: 30
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-cross-platform-nodejs - ps-list - Get running processes. (Libraries / Processes)
• awesome - sindresorhus/ps-list - Get running processes (JavaScript)
• awesome-nodejs-pure-js - ps-list

README

        
# ps-list

> Get running processes

Works on macOS, Linux, and Windows.

## Install

```sh

npm install ps-list

```

## Usage

```js

import psList from 'ps-list';

console.log(await psList());

//=> [{pid: 3213, name: 'node', cmd: 'node test.js', ppid: 1, uid: 501, cpu: 0.1, memory: 1.5}, …]

```

## API

### psList(options?)

Returns a `Promise` with the running processes.

On macOS and Linux, the `name` property is truncated to 15 characters by the system. The `cmd` property can be used to extract the full name.

The `cmd`, `cpu`, `memory`, and `uid` properties are not supported on Windows.

#### options

Type: `object`

##### all

Type: `boolean`\

Default: `true`

Include other users' processes as well as your own.

On Windows this has no effect and will always be the users' own processes.

## Related

- [fastlist](https://github.com/MarkTiedemann/fastlist) - The binary used in this module to list the running processes on Windows