eser 4.1.5 → 4.1.6

package/README.md

@@ -1,8 +1,10 @@
-# eser
+# 🖥️ [@eser/cli](./)
 
-Eser Ozvataf's command-line tooling to access things.
+Eser Ozvataf's command-line tooling to access things. A multi-purpose CLI that
+dispatches to library modules for codebase management, workflow automation,
+framework scaffolding, and more.
 
-## Installation
+## 🚀 Quick Start
 
 ```bash
 # Using npx (no installation required)
@@ -15,167 +17,203 @@ deno run --allow-all jsr:@eser/cli <command>
 npm install -g eser
 ```
 
-## Commands
+## 🛠 Command Tree
 
-### laroux
-
-laroux.js framework commands for building React Server Components applications.
-
-```bash
-eser laroux <subcommand> [options]
 ```
-
-**Subcommands:**
-
-- `init` - Create a new laroux.js project
-- `dev` - Start development server with hot reload
-- `build` - Build for production
-- `serve` - Serve production build locally
-
-#### init
-
-Create a new laroux.js project from a template.
-
-```bash
-eser laroux init [folder] [options]
+eser
+├── codebase              Codebase management tools
+│   ├── scaffolding       Initialize project from template
+│   ├── install           Install git hooks from .manifest.yml
+│   ├── uninstall         Remove managed git hooks
+│   ├── status            Show git hook installation status
+│   ├── versions          Manage workspace package versions
+│   ├── changelog-gen     Generate CHANGELOG from commits
+│   ├── release-notes     Sync changelog to GitHub Releases
+│   ├── release-tag       Create and push release git tags
+│   ├── validate-eof      Ensure files end with newline
+│   ├── validate-trailing-whitespace
+│   ├── validate-bom      Remove UTF-8 byte order markers
+│   ├── validate-line-endings
+│   ├── validate-large-files
+│   ├── validate-case-conflict
+│   ├── validate-merge-conflict
+│   ├── validate-json     Validate JSON syntax
+│   ├── validate-toml     Validate TOML syntax
+│   ├── validate-yaml     Validate YAML syntax
+│   ├── validate-symlinks
+│   ├── validate-shebangs
+│   ├── validate-secrets  Detect credentials and private keys
+│   ├── validate-filenames
+│   ├── validate-submodules
+│   ├── validate-commit-msg
+│   ├── validate-docs     Validate JSDoc documentation
+│   ├── validate-circular-deps
+│   ├── validate-export-names
+│   ├── validate-licenses
+│   ├── validate-mod-exports
+│   └── validate-package-configs
+├── workflows             Workflow engine — run tool pipelines
+│   ├── run               Run workflows by event or id
+│   └── list              List available workflows and tools
+├── laroux                laroux.js framework commands
+│   ├── init              Create a new laroux.js project
+│   ├── dev               Start development server with hot reload
+│   ├── build             Build for production
+│   └── serve             Serve production build locally
+├── system                Commands related with this CLI
+├── install               Install eser CLI globally
+├── update                Update eser CLI to latest version
+└── version               Show version number
 ```
 
-**Options:**
+## 📋 Commands
 
-- `-t, --template <name>` - Project template (minimal, blog, dashboard, docs)
-  (default: minimal)
-- `-f, --force` - Overwrite existing files
-- `--no-git` - Skip git initialization
-- `--no-install` - Skip dependency installation
+### workflows
 
-**Examples:**
+Run tool pipelines driven by events (pre-commit, pre-push, etc.).
 
 ```bash
-# Create a new project with default template
-eser laroux init my-app
+# Run all tools for a specific event
+npx eser workflows run -e precommit
 
-# Create a blog project
-eser laroux init my-blog --template blog
+# Run all tools for pre-push
+npx eser workflows run -e prepush
 
-# Create without installing dependencies
-eser laroux init my-app --no-install
+# List available workflows and tools
+npx eser workflows list
 ```
 
-#### dev
+### codebase
 
-Start the development server with hot module replacement.
+Codebase management, validation, and release tools.
 
 ```bash
-eser laroux dev [options]
-```
+# Initialize a new project from template
+npx eser codebase scaffolding
+npx eser codebase init    # alias for scaffolding
 
-**Options:**
+# Install git hooks
+npx eser codebase install
 
-- `-p, --port <number>` - Server port (default: 8000)
-- `-o, --open` - Open browser automatically
-- `--no-hmr` - Disable hot module replacement
-- `--log-level <level>` - Log level: debug, info, warn, error (default: info)
+# Check git hook installation status
+npx eser codebase status
 
-**Examples:**
+# Remove managed git hooks
+npx eser codebase uninstall
 
-```bash
-# Start dev server on default port
-eser laroux dev
+# Validate JSON files
+npx eser codebase validate-json
 
-# Start on custom port and open browser
-eser laroux dev --port 3000 --open
-```
+# Validate YAML files
+npx eser codebase validate-yaml
 
-#### build
+# Detect secrets and credentials
+npx eser codebase validate-secrets
 
-Build the application for production.
+# Run all validation checks
+npx eser codebase validate-eof
+npx eser codebase validate-trailing-whitespace
+npx eser codebase validate-bom
+npx eser codebase validate-line-endings
 
-```bash
-eser laroux build [options]
+# Release management
+npx eser codebase versions
+npx eser codebase changelog-gen
+npx eser codebase release-notes
+npx eser codebase release-tag
 ```
 
-**Options:**
-
-- `--out-dir <path>` - Output directory (default: dist)
-- `--clean` - Clean output directory first
-- `--no-minify` - Disable minification
-- `--analyze` - Analyze bundle size
+### laroux
 
-**Examples:**
+laroux.js framework commands for building React Server Components applications.
 
 ```bash
-# Production build
-eser laroux build
+# Create a new laroux.js project
+npx eser laroux init my-app
+npx eser laroux init my-blog --template blog
 
-# Build with bundle analysis
-eser laroux build --analyze
+# Start development server
+npx eser laroux dev
+npx eser laroux dev --port 3000 --open
 
-# Build to custom directory
-eser laroux build --out-dir ./output --clean
-```
+# Build for production
+npx eser laroux build
+npx eser laroux build --analyze
 
-#### serve
+# Serve production build
+npx eser laroux serve
+npx eser laroux serve --port 8080
+```
 
-Serve the production build locally for testing.
+#### laroux init
 
 ```bash
-eser laroux serve [options]
+eser laroux init [folder] [options]
 ```
 
-**Options:**
-
-- `-p, --port <number>` - Server port (default: 8000)
-- `--dist-dir <path>` - Distribution directory (default: dist)
+| Option           | Description                                      |
+| ---------------- | ------------------------------------------------ |
+| `-t, --template` | Project template: minimal, blog, dashboard, docs |
+| `-f, --force`    | Overwrite existing files                         |
+| `--no-git`       | Skip git initialization                          |
+| `--no-install`   | Skip dependency installation                     |
 
-**Examples:**
+#### laroux dev
 
 ```bash
-# Serve production build
-eser laroux serve
-
-# Serve on custom port
-eser laroux serve --port 8080
+eser laroux dev [options]
 ```
 
----
-
-### codebase
+| Option        | Description                         |
+| ------------- | ----------------------------------- |
+| `-p, --port`  | Server port (default: 8000)         |
+| `-o, --open`  | Open browser automatically          |
+| `--no-hmr`    | Disable hot module replacement      |
+| `--log-level` | Log level: debug, info, warn, error |
 
-Codebase validation and management tools.
+#### laroux build
 
 ```bash
-eser codebase <subcommand> [options]
+eser laroux build [options]
 ```
 
-**Subcommands:**
+| Option        | Description                      |
+| ------------- | -------------------------------- |
+| `--out-dir`   | Output directory (default: dist) |
+| `--clean`     | Clean output directory first     |
+| `--no-minify` | Disable minification             |
+| `--analyze`   | Analyze bundle size              |
 
-- `check` - Run all codebase checks
-- `check-circular-deps` - Check for circular dependencies
-- `check-docs` - Check documentation coverage
-- `check-export-names` - Check export naming conventions
-- `check-licenses` - Check license compliance
-- `check-mod-exports` - Check module exports
-- `check-package-configs` - Check package configurations
-- `init` - Initialize a new project from a template
+#### laroux serve
 
-**Options:**
+```bash
+eser laroux serve [options]
+```
 
-- `-h, --help` - Show help message
-- `--root <path>` - Root directory (default: current directory)
+| Option       | Description                            |
+| ------------ | -------------------------------------- |
+| `-p, --port` | Server port (default: 8000)            |
+| `--dist-dir` | Distribution directory (default: dist) |
 
-**Examples:**
+### system
 
 ```bash
-# Run all checks on current directory
-eser codebase check
+# Install eser CLI globally
+npx eser install
 
-# Check for circular dependencies
-eser codebase check-circular-deps
+# Update to the latest version
+npx eser update
 
-# Run checks on a specific directory
-eser codebase check --root ./my-project
+# Show version
+npx eser version
+npx eser version --bare   # version number only
 ```
 
 ## License
 
 Apache-2.0
+
+---
+
+🔗 For further details, visit the
+[eserstack repository](https://github.com/eser/stack).