Johannes7k75/PM2_utils

PM2 Process List CLI

A simple CLI tool to display PM2 process information in a table format.

Table of Contents

• Installation
• Usage
• Options
• Contributing
• License

Installation

Make sure you have Node.js and PM2 installed on your system.

1. Clone this repository:

   git clone https://github.com/Johannes7k75/PM2_utils.git

2. Install project dependencies:

   cd PM2_utils
   npm install

3. Run the CLI tool:

   node pm2-list.js

Usage

This tool displays a list of PM2 processes in a table format. By default, it shows basic process information such as process ID, name, uptime, restart count, and status. You can optionally include CPU and memory usage information by using the --perf flag.

node pm2-list.js

To include CPU and memory usage information:

node pm2-list.js --perf

Options

• --perf: Include CPU and memory usage information in the table.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these guidelines:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and test them thoroughly.
4. Commit your changes with clear and concise commit messages.
5. Push your changes to your fork.
6. Create a pull request to the main branch of this repository.

Please make sure to follow the Code of Conduct and Contributing Guidelines.

License

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

In this README, I've included sections for installation, usage, options, contributing guidelines, and licensing information. You can add more details as needed, such as examples, troubleshooting, or any other relevant information for users and contributors to your project.