# ps-list

> Get running processes

Latest version **9.0.0** (published 2025-09-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install ps-list
pnpm add ps-list
yarn add ps-list
bun add ps-list
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 9.0.0 |
| Published | 2025-09-26 |
| First published | 2015-05-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=20 |
| Dependencies | 0 |
| Unpacked size | 491.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 287 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | ps, proc, process, processes, list, running, tasklist |

## Links

- npm: https://www.npmjs.com/package/ps-list
- Repository: https://github.com/sindresorhus/ps-list
- Homepage: https://github.com/sindresorhus/ps-list#readme
- Issues: https://github.com/sindresorhus/ps-list/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/ps-list

## Recent versions

- 9.0.0 (latest) — 2025-09-26
- 8.1.1 — 2022-12-26
- 8.1.0 — 2022-01-17
- 8.0.0 — 2021-11-04
- 7.2.0 — 2020-06-17
- 7.1.0 — 2020-05-26
- 7.0.0 — 2020-02-11
- 6.3.0 — 2019-03-31
- 6.2.0 — 2019-03-08
- 6.1.0 — 2019-01-20
- 6.0.0 — 2018-10-13
- 5.0.1 — 2018-10-02
- 5.0.0 — 2018-07-23
- 4.1.0 — 2018-05-01
- 4.0.0 — 2017-07-27
- … 7 more at https://npm.io/package/ps-list/versions

## README

# ps-list

> Get running processes

Works on macOS, Linux, and Windows. Windows ARM64 is not supported yet.

## 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, path: '/usr/local/bin/node', startTime: 2025-01-15T10:30:00.000Z}, …]
```

## API

### psList(options?)

Returns a `Promise<ProcessDescriptor[]>` with the running processes.

On macOS and Linux:
- The `name` property is truncated to 15 characters by the system
- The `cmd` property contains the full command line with arguments
- The `cpu` property is the CPU usage percentage (0-100)
- The `memory` property is the memory usage percentage (0-100)
- The `path` property is a best-effort attempt to get the full executable path:
  - On Linux: reads from `/proc/{pid}/exe` when available
  - On macOS: extracted from command line when possible
  - Falls back to `comm` (which may be truncated)
- The `startTime` property contains the process start time as a Date object

The `cmd`, `cpu`, `memory`, `uid`, `path`, and `startTime` properties are not available 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 user's own processes.

## Related

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

---
_Source: https://npm.io/package/ps-list · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._