Socket
Socket
Sign inDemoInstall

ps-list

Package Overview
Dependencies
0
Maintainers
1
Versions
21
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    ps-list

Get running processes


Version published
Weekly downloads
1.6M
increased by4.72%
Maintainers
1
Install size
483 kB
Created
Weekly downloads
 

Package description

What is ps-list?

The ps-list npm package is a tool for listing running processes on the system. It provides a simple and cross-platform way to retrieve information about the processes running on a machine, including their PID (Process ID), name, and other details. This can be particularly useful for monitoring system health, debugging applications, or managing system resources programmatically.

What are ps-list's main functionalities?

Fetching a list of running processes

This feature allows you to fetch a list of all running processes on the system. The returned list includes details such as the process ID (pid), name, and other process-related information. This can be useful for monitoring which processes are currently active.

const psList = require('ps-list');

(async () => {
  const processes = await psList();
  console.log(processes);
})();

Fetching running processes with detailed information

By setting the 'all' option to true, you can fetch a more detailed list of running processes. This includes additional information such as the process's CPU and memory usage, which can be crucial for more in-depth system monitoring and analysis.

const psList = require('ps-list');

(async () => {
  const processes = await psList({all: true});
  console.log(processes);
})();

Other packages similar to ps-list

Readme

Source

ps-list

Get running processes

Works on macOS, Linux, and Windows.

Install

npm install ps-list

Usage

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<object[]> 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.

  • fastlist - The binary used in this module to list the running processes on Windows

Keywords

FAQs

Last updated on 26 Dec 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc