@bitcall/pm2-pulse-agent 1.0.1-beta.1 → 1.0.1-beta.2

package/README.md

@@ -14,7 +14,7 @@ A Node.js monitoring agent that tracks server metrics (CPU, RAM, processes) and
 ## Installation
 
 ```bash
-npm install
+npm install @bitcall/pm2-pulse-agent@beta
 ```
 
 ### Dependencies
@@ -28,7 +28,14 @@ npm install
 Run the interactive setup script to configure the agent:
 
 ```bash
-npm run setup-agent
+npx @bitcall/pm2-pulse-agent pm2-pulse-setup
+```
+
+Or if installed globally:
+
+```bash
+npm install -g @bitcall/pm2-pulse-agent@beta
+pm2-pulse-setup
 ```
 
 This will prompt you to configure:
@@ -36,16 +43,25 @@ This will prompt you to configure:
 - **MONITOR_SERVER**: gRPC server address (default: `localhost:50051`)
 - **VPS_ID**: Unique identifier for this server (default: `server-{hostname}`)
 
-Settings are saved to `.env` file.
+Settings are saved to `.env` file in your current directory.
 
 ## Usage
 
 ### Start the Agent
 
+**Using npx (recommended):**
+```bash
+npx @bitcall/pm2-pulse-agent pm2-pulse-agent
+```
+
+**If installed globally:**
+```bash
+pm2-pulse-agent
+```
+
+**Run with PM2 (for persistent monitoring):**
 ```bash
-npm run agent
-# or
-npm run monitor
+pm2 start "npx @bitcall/pm2-pulse-agent pm2-pulse-agent" --name pm2-pulse-agent
 ```
 
 ### Configuration Options
@@ -118,6 +134,43 @@ RAM Threshold: 80%
 ✓ Alert sent to server
 ```
 
+## Quick Start Guide
+
+1. **Install the package:**
+   ```bash
+   npm install -g @bitcall/pm2-pulse-agent@beta
+   ```
+
+2. **Run setup:**
+   ```bash
+   pm2-pulse-setup
+   ```
+
+3. **Start monitoring:**
+   ```bash
+   pm2 start pm2-pulse-agent --name monitoring-agent
+   ```
+
+4. **Check status:**
+   ```bash
+   pm2 logs monitoring-agent
+   ```
+
+## Troubleshooting
+
+**Agent not connecting to server:**
+- Verify `MONITOR_SERVER` address is correct in `.env`
+- Check network connectivity: `telnet <server-host> <port>`
+- Ensure firewall allows outbound connections
+
+**PM2 processes not detected:**
+- Verify PM2 is installed: `pm2 --version`
+- Check PM2 has running processes: `pm2 list`
+
+**Authentication errors:**
+- Verify `AUTH_TOKEN` in `.env` matches server configuration
+- Check token hasn't expired
+
 ## License
 
-MIT
+MIT

package/agent.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 const os = require('os')
 const { exec } = require('child_process')
 const grpc = require('@grpc/grpc-js')

package/package.json

@@ -1,6 +1,10 @@
 {
   "name": "@bitcall/pm2-pulse-agent",
-  "version": "1.0.1-beta.1",
+  "version": "1.0.1-beta.2",
+  "bin": {
+    "pm2-pulse-setup": "./scripts/setup-agent.js",
+    "pm2-pulse-agent": "./agent.js"
+  },
   "scripts": {
     "agent": "node agent.js",
     "monitor": "node agent.js",

package/scripts/setup-agent.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 const fs = require('fs')
 const path = require('path')
 const readline = require('readline')