@yamanzyan/monitorx 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +43 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,8 @@
1
1
  # MonitorX
2
2
 
3
- A lightweight Node.js process manager with built-in cluster support. Run, monitor, and manage your Node.js processes from the command line.
3
+ MonitorX is a lightweight Node.js process manager with built-in cluster support. Run, monitor, restart, and inspect Node.js processes from the command line.
4
+
5
+ NPM package: [`@yamanzyan/monitorx`](https://www.npmjs.com/package/@yamanzyan/monitorx)
4
6
 
5
7
  ## Features
6
8
 
@@ -12,33 +14,53 @@ A lightweight Node.js process manager with built-in cluster support. Run, monito
12
14
 
13
15
  ## Installation
14
16
 
17
+ Install MonitorX globally:
18
+
15
19
  ```bash
16
- npm install -g monitorx
20
+ npm install -g @yamanzyan/monitorx
17
21
  ```
18
22
 
19
- The install script starts the MonitorX daemon in the background automatically.
20
- This also installs two binaries:
23
+ This installs the `monitorx` command globally and starts the MonitorX daemon in the background automatically.
24
+
25
+ Installed commands:
21
26
 
22
27
  | Binary | Purpose |
23
28
  |---|---|
24
29
  | `monitorx` | CLI — send commands to the daemon |
25
30
  | `monitorx-daemon` | Daemon — background process that manages your apps |
26
31
 
32
+ Check that the CLI is available:
33
+
34
+ ```bash
35
+ monitorx help
36
+ ```
37
+
27
38
  ## Quick Start
28
39
 
29
- **Start a process:**
40
+ After installing globally, start any Node.js script:
30
41
 
31
42
  ```bash
32
- # Start a script directly
33
43
  monitorx start server.js
44
+ ```
34
45
 
35
- # Start using a config file
36
- monitorx start
46
+ List managed processes:
37
47
 
38
- # List running processes
48
+ ```bash
39
49
  monitorx ls
40
50
  ```
41
51
 
52
+ Stream logs:
53
+
54
+ ```bash
55
+ monitorx logs
56
+ ```
57
+
58
+ Stop all managed processes:
59
+
60
+ ```bash
61
+ monitorx stop
62
+ ```
63
+
42
64
  If the daemon is not running, start it manually:
43
65
 
44
66
  ```bash
@@ -234,3 +256,15 @@ All MonitorX files live in `~/.monitorx/`:
234
256
  |---|---|
235
257
  | `daemon.sock` | Unix socket for CLI ↔ daemon communication |
236
258
  | `process_state.json` | Persisted process registry |
259
+
260
+ ## Publishing
261
+
262
+ Releases are created from GitHub Actions.
263
+
264
+ 1. Go to **Actions** → **Publish to npm** → **Run workflow**.
265
+ 2. Choose `patch`, `minor`, `major`, or `custom`.
266
+ 3. The workflow bumps `package.json` and `package-lock.json`, pushes a tag like `v1.0.1`, and creates a draft GitHub Release.
267
+ 4. Review the draft release in GitHub Releases.
268
+ 5. Click **Publish release** to publish `@yamanzyan/monitorx` to npm.
269
+
270
+ The npm publish step requires a GitHub Actions secret named `NPM_TOKEN`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yamanzyan/monitorx",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "A lightweight Node.js process manager with cluster support",
5
5
  "main": "dist/cli.js",
6
6
  "module": "dist/cli.js",