pid

pidtree

🚸 Cross platform children list of a PID.

Showing:

Popularity

Downloads/wk

2.3M

GitHub Stars

82

Maintenance

Last Commit

6mos ago

Contributors

2

Package

Dependencies

0

Size (min+gzip)

1.4KB

License

MIT

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

pidtree

Mac/Linux Build Status Windows Build status Codecov Coverage report Known Vulnerabilities Dependency Status
XO Code Style used AVA Test Runner used Istanbul Test Coverage used NI Scaffolding System used NP Release System used
Latest version on npm Project license

🚸 Cross platform children list of a PID.
Coded with ❀️ by Simone Primarosa.

Synopsis

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!

Usage

var pidtree = require('pidtree')

// Get childs of current process
pidtree(process.pid, function (err, pids) {
  console.log(pids)
  // => []
})

// Include the given pid in the result array
pidtree(process.pid, {root: true}, function (err, pids) {
  console.log(pids)
  // => [727]
})

// Get all the processes of the System (-1 is a special value of this package)
pidtree(-1, function (err, pids) {
  console.log(pids)
  // => [530, 42, ..., 41241]
})

// Include PPID in the results
pidtree(1, {advanced: true}, function (err, pids) {
  console.log(pids)
  // => [{ppid: 1, pid: 530}, {ppid: 1, pid: 42}, ..., {ppid: 1, pid: 41241}]
})

// If no callback is given it returns a promise instead
const pids = await pidtree(1)
console.log(pids)
// => [141, 42, ..., 15242]

Compatibility

LinuxFreeBSDNetBSDSunOSmacOSWinAIX
βœ…β“β“β“βœ…βœ…β“

βœ… = Working ❓ = Not tested but should work

Please if your platform is not supported file an issue.

CLI

pidtree cli Show a tree of the processes inside your system inside your terminal.
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

API

pidtree(pid, [options], [callback]) β‡’ [Promise.<Array.<Object>>]

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

ParamTypeDefaultDescription
pidNumber | StringA pid. If -1 will return all the pids.
[options]ObjectOptional options object.
[options.root]BooleanfalseInclude the provided pid in the list. Ignored if -1 is passed as pid.
[callback]functionCalled when the list is ready. If not provided a promise is returned instead.
  • pidusage - Cross-platform process cpu % and memory usage of a PID

Authors

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

License

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100