pidtree

Latest version on npm Downloads on npm Project license
Lint status Test macOS status Test Ubuntu status Test Windows status Codecov Coverage report Known Vulnerabilities
XO Code Style used AVA Test Runner used c8 Test Coverage used NI Scaffolding System used release-please Release System used

🚸 Cross platform children list of a PID.
_{Coded with ❤️ by Simone Primarosa.}

This package is really similar to ps-tree but is faster, safer and provides sub-children results.
Furthermore ps-tree is unmaintained.

Uuh, and a fancy CLI is also available!

npm install pidtree

Requirements: pidtree is an ESM-only package and requires Node.js >= 18. If you need CommonJS (require) or support for older Node.js versions, stay on pidtree@0.6.

import pidtree from 'pidtree'
// The named import works too: import {pidtree} from 'pidtree'
// Get children of the current process (a promise is returned)
const pids = await pidtree(process.pid)
console.log(pids)
// => []
// Include the given pid in the result array
console.log(await pidtree(process.pid, {root: true}))
// => [727]
// Get all the processes of the System (-1 is a special value of this package)
console.log(await pidtree(-1))
// => [530, 42, ..., 41241]
// Include the PPID in the results
console.log(await pidtree(1, {advanced: true}))
// => [{ppid: 1, pid: 530}, {ppid: 1, pid: 42}, ..., {ppid: 1, pid: 41241}]
// A Node-style callback is also supported instead of a promise
pidtree(1, function (err, pids) {
 console.log(pids)
 // => [141, 42, ..., 15242]
})

✅ = Working ❓ = Not tested but should work

Please if your platform is not supported file an issue.

pidtree cli

npx pidtree $PPID

Just replace $PPID with one of the pids inside your system.

Or don't pass anything if you want all the pids inside your system.

npx pidtree

To display the output as a list, similar to the one produced from pgrep -P $PID, pass the --list flag.

npx pidtree --list

Get the list of children pids of the given pid.

Kind: global function
Returns: Promise.<Array.<Object>> - Only when the callback is not provided.
Access: public

• pidusage - Cross-platform process cpu % and memory usage of a PID

• Simone Primarosa - simonepri

See also the list of contributors who participated in this project.

This project is licensed under the MIT License - see the license file for details.