neex 0.1.7 → 0.2.5

package/README.md

@@ -6,7 +6,7 @@
 </picture>
 </a>
 
-# Neex v0.1.7
+# Neex v0.2.5
 
 ### 🚀 Neex: The Modern Build System for Polyrepo-in-Monorepo Architecture
 
@@ -20,12 +20,12 @@
 
 next + express = neex 🌱
 
-Neex is a modern build system and script runner designed for **Polyrepo-in-Monorepo** architectures, but powerful enough for any project. It simplifies managing and running multiple scripts across your project, whether they are microservices, frontend applications, or build tasks. Neex offers robust features like parallel and sequential execution, live-reloading for development (`watch`), optimized server running (`servers`), and even basic process management (`pm2`-like commands), all aimed at making your development workflow more efficient, organized, and visually clear.
+Neex is a modern build system designed to bridge the gap between polyrepo and monorepo architectures. It provides powerful script execution capabilities with features like parallel processing, colored output, and intelligent build orchestration. Whether you're managing a complex monorepo or coordinating multiple repositories, neex makes your development workflow more efficient and visually organized.
 
 ## ✨ Key Features
 
 - 🎨 **Colored Output** - Distinguish commands with unique colors
-- ⚡ **Dual Execution Modes** - Run commands in parallel (`px`) or sequence (`s`, `run`)
+- ⚡ **Dual Execution Modes** - Run commands in parallel (`p`, `runx`) or sequence (`s`, `run`)
 - ⏱️ **Smart Timing** - Track execution time for each command
 - 🛑 **Error Control** - Stop on first error (perfect for CI/CD)
 - 🔢 **Parallel Control** - Limit concurrent processes with `--max-parallel`
@@ -34,24 +34,7 @@ Neex is a modern build system and script runner designed for **Polyrepo-in-Monor
 - 🤫 **Flexible Display** - Control prefixes, timing, and output visibility
 - 🧰 **Node.js API** - Programmatic usage in your applications
 
-## 🚀 Installation
-
-Install Neex globally to use it anywhere, or locally in your project.
-
-```bash
-# Global install
-npm install -g neex
-
-# Local install
-npm install --save-dev neex    # npm
-yarn add --dev neex          # yarn
-pnpm add --save-dev neex     # pnpm
-bun add --dev neex           # bun
-```
-
-When installed locally, you can run Neex commands using `npx neex ...` or by adding them to your `package.json` scripts.
-
-## 🖥️ Usage
+## ⚡ Quick Start
 
 ```bash
 # Global install
@@ -66,147 +49,35 @@ bun add -D neex  # bun
 
 ## 🖥️ Usage
 
-### Core Commands
-
-Neex provides several commands to manage and run your scripts:
-
-- **`px <commands...>`** (*default command*)
-  - Runs specified commands in **parallel** by default.
-  - Use the `-q` or `--sequential` flag to run them sequentially.
-  - Ideal for build steps, tests, or any tasks that can run concurrently.
-
-- **`run <commands...>`** (alias: `s`)
-  - Runs specified commands **sequentially**.
-  - Useful for tasks that depend on the completion of previous ones (e.g., build then deploy).
+### Commands
 
-- **`servers <commands...>`** (alias: `srv`)
-  - Optimized for running multiple development **servers** (e.g., backend API, frontend app) in parallel.
-  - Provides grouped and clear output for each server, making it easy to monitor logs.
-  - Detects and displays server ports and URLs.
+- `runx` (alias: `p`) - Run in **parallel** (default)
+- `run` (alias: `s`) - Run **sequentially**
 
-- **`watch <commands...>`** (alias: `w`)
-  - Runs commands and **watches for file changes** to automatically restart them (Nodemon-like functionality).
-  - Highly configurable with options for watched paths, ignored patterns, extensions, and restart delays.
-  - Perfect for development workflows where you need instant feedback on code changes.
-
-- **Process Management Commands**
-  - Neex provides built-in process management capabilities, similar to PM2, for long-running applications. These commands operate directly under `neex`:
-    - **`start <script_path_or_command> [--name <name>] [--watch] [-- <args...>]`**: Start a new process.
-    - **`stop <name_or_id>`**: Stop a running process.
-    - **`restart <name_or_id>`**: Restart a running process.
-    - **`delete <name_or_id>`**: Stop and delete a process from the list.
-    - **`list`** (aliases: `ls`, `status`): List all managed processes.
-    - **`logs [name_or_id] [--lines <number>] [--follow]`**: Display logs for a specific process or all if no ID is given.
-    - **`monit`**: Launch a monitoring interface for all managed processes.
-    - **`save`**: Save the current list of running processes.
-    - **`resurrect`**: Restart processes that were previously saved.
-    - **`startup`**: Generate a sample startup script (e.g., for systemd).
-
-### General Command Examples
+### Examples
 
 ```bash
-# Parallel execution (default behavior for px)
-neex px "npm run build:api" "npm run build:frontend" "npm run lint"
-# px is the command for parallel execution
-neex px "npm run test:unit" "npm run test:integration"
+# Parallel execution (default)
+neex p "echo Task 1" "echo Task 2" "echo Task 3"
 
 # Sequential execution
-neex run "npm run clean" "npm run build" "npm run deploy"
-# Alias for sequential
-neex s "echo First" "echo Second" "echo Third"
-
-# Run 'px' commands sequentially using the -q flag
-neex px -q "npm run step1" "npm run step2"
-```
-
-### `servers` Command Examples
-
-```bash
-# Start frontend and backend development servers
-neex servers "cd frontend && npm start" "cd backend && npm start"
+neex s "echo Step 1" "echo Step 2" "echo Step 3"
 
-# Group output for better readability
-neex servers --group-output "npm run dev:service-a" "npm run dev:service-b"
+# Parallel with sequential flag
+neex p -q "echo Step 1" "echo Step 2" "echo Step 3"
 ```
 
-### `watch` Command Examples
-
-```bash
-# Watch for changes in './src' and restart 'npm run build'
-neex watch "npm run build" -w ./src
-
-# Watch for .ts file changes in 'services/' and restart two commands, ignoring 'node_modules'
-neex watch "npm run start:service1" "npm run start:service2" -w services/ -e ts -i node_modules/**
+### 🛠️ Options
 
-# Clear console on restart and set a delay
-neex watch "node server.js" --clear --delay 1500
-```
-
-### Process Management Command Examples
-
-```bash
-# Start a Node.js app and give it a name
-neex start server.js --name my-app
-
-# Start an app and watch for file changes
-neex start api/index.js --name my-api --watch
-
-# List all running processes managed by neex
-neex list
-
-# View logs for 'my-app'
-neex logs my-app
-
-# Stop 'my-api'
-neex stop my-api
-
-# Restart 'my-app'
-neex restart my-app
-
-# Delete 'my-api' from neex management
-neex delete my-api
-```
-
-### 🛠️ Global Options (for `run`, `px`, `servers`)
-
-These options can be used with `run`, `px`, and `servers` commands:
-
-| Flag                     | Alias | Description                                       | Default        |
-|--------------------------|-------|---------------------------------------------------|----------------|
-| `--no-color`             | `-c`  | Disable colored output                            | `true` (color on) |
-| `--no-timing`            | `-t`  | Hide timing information for each command          | `true` (timing on) |
-| `--no-prefix`            | `-p`  | Hide command prefix in output                     | `true` (prefix on) |
-| `--stop-on-error`        | `-s`  | Stop all further execution if a command fails     | `false`        |
-| `--no-output`            | `-o`  | Hide all `stdout` and `stderr` from commands      | `true` (output on) |
-| `--minimal`              |       | Use minimal output format (less verbose)          | `false`        |
-| `--max-parallel <number>`|       | Maximum number of commands to run in parallel     | CPU count      |
-| `--sequential`           | `-q`  | (For `px`) Run commands sequentially instead of parallel | `false`        |
-| `--retry <count>`        |       | Number of times to retry a failed command         | `0`            |
-| `--retry-delay <ms>`     |       | Delay in milliseconds between retries             | `1000`         |
-| `--group-output`         | `-g`  | (For `servers`) Group output by server            | `false`        |
-
-### `watch` Command Options
-
-| Flag                        | Alias | Description                                          | Default                                    |
-|-----------------------------|-------|------------------------------------------------------|--------------------------------------------|
-| `--watch <paths...>`        | `-w`  | Paths/glob patterns to watch                         | `['./']`                                   |
-| `--ignore <patterns...>`    | `-i`  | Paths/glob patterns to ignore                        | `['node_modules/**', '.git/**', ...]`       |
-| `--ext <extensions...>`     | `-e`  | File extensions to watch                             | `['js', 'mjs', 'json', 'ts', 'tsx', 'jsx']`|
-| `--delay <ms>`              | `-d`  | Delay in milliseconds before restarting after a change | `1000`                                     |
-| `--clear`                   |       | Clear console on restart                             | `false`                                    |
-| `--verbose`                 |       | Show verbose output from the watcher                 | `false`                                    |
-| `--signal <signal>`         |       | Signal to send to processes on restart               | `SIGTERM`                                  |
-| *Global options also apply* |       | `no-color`, `no-timing`, etc.                        |                                            |
-
-### `start` Command Options
-
-| Flag                        | Description                                      | Default   |
-|-----------------------------|--------------------------------------------------|-----------|
-| `--name <name>`             | Specify a name for the process                   | Script name |
-| `--watch`                   | Enable file watching and auto-restart            | `false`   |
-| `--ignore-watch <paths...>` | Paths/patterns to ignore when watching           |           |
-| `--watch-delay <ms>`        | Delay for watch restarts                         | `1000`    |
-| `-- <args...>`              | Arguments to pass to the script                  |           |
+| Flag | Alias | Description | Default |
+|------|-------|-------------|----------|
+| `--no-color` | `-c` | Disable colors | `false` |
+| `--no-timing` | `-t` | Hide timing | `false` |
+| `--no-prefix` | `-p` | Hide prefixes | `false` |
+| `--stop-on-error` | `-s` | Stop on failure | `false` |
+| `--no-output` | `-o` | Hide all output | `false` |
+| `--max-parallel` | `-m` | Max parallel tasks | CPU count |
+| `--sequential` | `-q` | Force sequential | `false` |
 
 
 ### Advanced Example
@@ -244,38 +115,17 @@ async function main() {
 }
 ```
 
-### API Options (`RunOptions`)
-
-When using Neex programmatically, you can pass an options object to the `run` function:
+### API Options
 
 ```typescript
-export interface RunOptions {
-  // Run in parallel or sequentially
-  parallel: boolean;
-  // Maximum number of parallel processes (default: CPU count)
-  maxParallel?: number;
-  // Show command output (default: true)
-  printOutput: boolean;
-  // Color output (default: true)
-  color: boolean;
-  // Show timing information (default: true)
-  showTiming: boolean;
-  // Show command prefix (default: true)
-  prefix: boolean;
-  // Stop on error (default: false)
-  stopOnError: boolean;
-  // Use minimal output format (default: false)
-  minimalOutput: boolean;
-  // Group output by command (default: false, mainly for server mode)
-  groupOutput: boolean;
-  // Use server mode formatting (default: false)
-  isServerMode: boolean;
-  // Number of times to retry a failed command (default: 0)
-  retry?: number;
-  // Delay in milliseconds between retries (default: 1000)
-  retryDelay?: number;
-  // Callback to register a cleanup function, called on SIGINT/SIGTERM
-  registerCleanup?: (cleanupFn: () => void) => void;
+interface RunOptions {
+  parallel?: boolean;     // Run in parallel (default: true)
+  maxParallel?: number;  // Max parallel processes (default: CPU count)
+  color?: boolean;       // Enable colors (default: true)
+  prefix?: boolean;      // Show command prefix (default: true)
+  showTiming?: boolean;  // Show timing info (default: true)
+  printOutput?: boolean; // Show command output (default: true)
+  stopOnError?: boolean; // Stop on failure (default: false)
 }
 ```
 
@@ -291,54 +141,17 @@ steps:
     run: neex p -s -m 4 "npm run lint" "npm test" "npm run e2e"
 ```
 
-## 💡 Real-world Scenarios & `package.json` Integration
-
-Neex shines when integrated into your `package.json` scripts.
-
-**Example `package.json` scripts:**
-
-```json
-{
-  "scripts": {
-    "dev:frontend": "cd packages/frontend && npm run dev",
-    "dev:backend": "cd packages/api && npm run dev",
-    "dev": "neex servers \"npm run dev:frontend\" \"npm run dev:backend\" --group-output",
-
-    "build:ui": "cd packages/ui-library && npm run build",
-    "build:app": "cd packages/main-app && npm run build",
-    "build": "neex runx \"npm run build:ui\" \"npm run build:app\"",
-
-    "test": "neex runx -s \"npm run test:unit\" \"npm run test:e2e\"",
-    "test:unit": "jest",
-    "test:e2e": "playwright test",
-
-    "lint": "eslint .",
-    "format": "prettier --write .",
-    "check-all": "neex p \"npm run lint\" \"npm run format -- --check\" \"npm run test\"",
-
-    "start:prod": "neex pm2 start dist/server.js --name my-prod-app",
-    "watch:build": "neex watch \"npm run build:app\" -w packages/main-app/src -e ts,tsx"
-  }
-}
-```
-
-**Running these scripts:**
+## 💡 Real-world Examples
 
 ```bash
-# Start all development servers with grouped output
-npm run dev
-
-# Build UI library and main application in parallel
-npm run build
-
-# Run linters, format check, and all tests in parallel
-npm run check-all
+# Dev servers
+neex p "cd frontend && npm dev" "cd api && npm dev"
 
-# Start the production application using neex's pm2
-npm run start:prod
+# Monorepo build
+neex p -m 2 "npm run build:ui" "npm run build:api"
 
-# Watch for changes in the main app's src and rebuild it
-npm run watch:build
+# Deploy pipeline
+neex s -s "npm test" "npm run build" "npm run deploy"
 ```
 
 ## 🤝 Contributing