@pc360/chlog 0.1.8 → 0.1.9

package/CHANGELOG.md

@@ -11,6 +11,12 @@ The format is based on Keep a Changelog, and this project follows Semantic Versi
 - Removed Ink card border lines so help and status output no longer render inside a box.
 - Added blank lines before and after help and error output to improve readability.
 
+## [0.1.9] - 2026-02-14
+
+### Changed
+
+- Update docs with a global installation and add --version option
+
 ## [0.1.8] - 2026-02-14
 
 ### Changed

package/README.md

@@ -17,16 +17,80 @@ Each entry file is automatically:
 
 ---
 
-## 🚀 Usage
+## 📦 Install
+
+```bash
+npm i -g @pc360/chlog
+```
+
+## ✅ After Installation
+
+If `chlog` is not recognized after global install, add your npm global `bin` path to `PATH`.
+
+1. Get your npm prefix:
+
+```bash
+npm get prefix
+```
+
+2. Use the output as `<prefix>`, then add this to your shell config:
+
+```bash
+export PATH="$PATH:<prefix>/bin"
+```
+
+For `zsh`, add it to `~/.zshrc`.
+For `bash`, add it to `~/.bashrc`.
+
+3. Reload your shell config (or open a new terminal):
 
+```bash
+source ~/.zshrc
+# or
+source ~/.bashrc
 ```
+
+Then run:
+
+```bash
+# Dry run (preview only)
+chlog --type <added|changed|fixed|removed> \
+      --scope <scope> \
+      --message "<description>" \
+      [--frontend] \
+      --dry-run
+
+# Dry run short form (preview only)
+chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f] -d
+
+# Create entry
+chlog --type <added|changed|fixed|removed> \
+      --scope <scope> \
+      --message "<description>" \
+      [--frontend]
+```
+
+You can also run it without global install:
+
+```bash
 npx @pc360/chlog --type <added|changed|fixed|removed> \
-                         --scope <scope> \
-                         --message "<description>" \
-                         [--frontend]
+                 --scope <scope> \
+                 --message "<description>" \
+                 [--frontend]
+```
+
+---
+
+## 🚀 Usage
+
+```bash
+chlog --type <added|changed|fixed|removed> \
+      --scope <scope> \
+      --message "<description>" \
+      [--frontend]
 
 # Short form
-npx @pc360/chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f]
+chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f]
 ```
 
 ---
@@ -41,6 +105,7 @@ npx @pc360/chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>"
 | `-f, --frontend` | ❌       | Uses `[Front-End]` instead of `[Back-End]`          |
 | `-d, --dry-run`  | ❌       | Preview file creation without writing               |
 | `-h, --help`     | ❌       | Show help                                           |
+| `-v, --version`  | ❌       | Show CLI version                                    |
 
 ---
 
@@ -49,7 +114,7 @@ npx @pc360/chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>"
 ### Back-End Change (Default)
 
 ```
-npx @pc360/chlog --type added --scope JES-33 --message "Add daily consolidated JE job"
+chlog --type added --scope JES-33 --message "Add daily consolidated JE job"
 ```
 
 Creates:
@@ -69,7 +134,7 @@ File content:
 ### Front-End Change
 
 ```
-npx @pc360/chlog --type fixed --scope JES-45 --frontend --message "Fix table pagination issue"
+chlog --type fixed --scope JES-45 --frontend --message "Fix table pagination issue"
 ```
 
 File content:
@@ -83,7 +148,7 @@ File content:
 ### Module-Based Scope
 
 ```
-npx @pc360/chlog --type changed --scope "Credit Validation" --message "Improve credit limit computation"
+chlog --type changed --scope "Credit Validation" --message "Improve credit limit computation"
 ```
 
 File content:
@@ -153,7 +218,7 @@ Fix FR status blocking issue
 Preview without creating file:
 
 ```
-npx @pc360/chlog --type added --scope JES-99 --message "Test entry" --dry-run
+chlog --type added --scope JES-99 --message "Test entry" --dry-run
 ```
 
 ---

package/bin/chlog.js

@@ -3,6 +3,7 @@
 
 const fs = require("fs/promises");
 const path = require("path");
+const { version } = require("../package.json");
 
 const {
   parseArgs,
@@ -39,6 +40,7 @@ Options:
   --tz "<iana>"          Timezone (default: Asia/Manila)
   -d, --dry-run          Preview only
   -h, --help             Show help
+  -v, --version          Show version
 `.trim();
 }
 
@@ -51,6 +53,11 @@ async function main() {
       process.exit(0);
     }
 
+    if (args.version) {
+      process.stdout.write(`${version}\n`);
+      process.exit(0);
+    }
+
     validateArgs(args);
 
     const timestamp = generateTimestamp(new Date(), args.tz);

package/lib/chlog-lib.js

@@ -11,6 +11,7 @@ function parseArgs(argv) {
     frontend: false,
     dryRun: false,
     help: false,
+    version: false,
   };
 
   for (let i = 2; i < argv.length; i++) {
@@ -21,6 +22,11 @@ function parseArgs(argv) {
       break;
     }
 
+    if (arg === "-v" || arg === "--version") {
+      args.version = true;
+      break;
+    }
+
     if (arg === "--dry-run" || arg === "-d") {
       args.dryRun = true;
       continue;

package/lib/chlog-ui.js

@@ -136,7 +136,7 @@ async function renderHelp(helpText) {
 
   const rendered = await renderInkCard(
     {
-      title: "PC360 Changelog CLI - v0.1.8",
+      title: "PC360 Changelog CLI",
       subtitle: "Usage & options",
       lines: styledLines,
       tone: "info",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pc360/chlog",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "PC360 Changelog CLI Tool",
   "author": "aalmazan@pcdsi.ph",
   "bin": {