@pc360/chlog 0.1.9 → 0.1.10

package/CHANGELOG.md

@@ -8,8 +8,16 @@ The format is based on Keep a Changelog, and this project follows Semantic Versi
 
 ### Changed
 
+- No changes yet.
+
+## [0.1.10] - 2026-02-15
+
+### Changed
+
 - 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.
+- Reorganized README onboarding flow into: installation, first-time dry-run usage, and troubleshooting.
+- Added explicit `command not found: chlog` guidance, including PATH updates for `~/.zshrc` / `~/.bashrc` (with `~/.zhsrc` note).
 
 ## [0.1.9] - 2026-02-14
 
@@ -21,7 +29,7 @@ The format is based on Keep a Changelog, and this project follows Semantic Versi
 
 ### Changed
 
-- Update docs
+- Update docs.
 
 ## [0.1.7] - 2026-02-14
 

package/README.md

@@ -2,166 +2,140 @@
 
 Internal CLI tool for creating structured changelog entries under:
 
-```
+```text
 changelog/unreleased/{added|changed|fixed|removed}
 ```
 
-The CLI now renders polished terminal cards using `ink` in interactive terminals, with plain-text fallback for scripts/CI.
-
-Each entry file is automatically:
+Each entry is automatically:
 
-- Named using Asia/Manila timestamp (`YYYYMMDDHHmmss`)
+- Named with Asia/Manila timestamp (`YYYYMMDDHHmmss`)
 - Placed in the correct type directory
-- Written as a single clean line
+- Written as one clean line
 - Prefixed with scope and layer (`Back-End` or `Front-End`)
 
----
+## 1. Installation
+
+Requirements:
 
-## 📦 Install
+- Node.js `>= 18`
+
+Install globally:
 
 ```bash
 npm i -g @pc360/chlog
 ```
 
-## ✅ After Installation
+Alternative (without global install):
+
+```bash
+npx @pc360/chlog --type <added|changed|fixed|removed> --scope <scope> --message "<description>"
+```
 
-If `chlog` is not recognized after global install, add your npm global `bin` path to `PATH`.
+## 2. First-Time Usage (Dry Run First)
 
-1. Get your npm prefix:
+For first use, always run a dry run to preview output without creating a file:
 
 ```bash
-npm get prefix
+chlog --type added --scope JES-99 --message "Test entry" --dry-run
 ```
 
-2. Use the output as `<prefix>`, then add this to your shell config:
+Short form:
 
 ```bash
-export PATH="$PATH:<prefix>/bin"
+chlog -t added -s JES-99 -m "Test entry" -d
 ```
 
-For `zsh`, add it to `~/.zshrc`.
-For `bash`, add it to `~/.bashrc`.
-
-3. Reload your shell config (or open a new terminal):
+If the preview is correct, run the actual command:
 
 ```bash
-source ~/.zshrc
-# or
-source ~/.bashrc
+chlog --type added --scope JES-99 --message "Test entry"
 ```
 
-Then run:
+## 3. If `chlog` Is Not Found
+
+If you see `command not found: chlog` after installation, add npm global `bin` to your `PATH`.
+
+1. Get npm prefix:
 
 ```bash
-# Dry run (preview only)
-chlog --type <added|changed|fixed|removed> \
-      --scope <scope> \
-      --message "<description>" \
-      [--frontend] \
-      --dry-run
+npm get prefix
+```
 
-# Dry run short form (preview only)
-chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f] -d
+2. Add this line to your shell config (replace `<prefix>` with output above):
 
-# Create entry
-chlog --type <added|changed|fixed|removed> \
-      --scope <scope> \
-      --message "<description>" \
-      [--frontend]
+```bash
+export PATH="$PATH:<prefix>/bin"
 ```
 
-You can also run it without global install:
+3. Save to the right file:
+
+- `zsh`: `~/.zshrc` (or `~/.zhsrc` if your environment uses that filename)
+- `bash`: `~/.bashrc`
+
+4. Reload shell:
 
 ```bash
-npx @pc360/chlog --type <added|changed|fixed|removed> \
-                 --scope <scope> \
-                 --message "<description>" \
-                 [--frontend]
+source ~/.zshrc
+# or
+source ~/.bashrc
 ```
 
----
+5. Verify:
 
-## 🚀 Usage
+```bash
+chlog --version
+```
+
+## Usage
 
 ```bash
 chlog --type <added|changed|fixed|removed> \
       --scope <scope> \
       --message "<description>" \
       [--frontend]
+```
 
-# Short form
+Short form:
+
+```bash
 chlog -t <added|changed|fixed|removed> -s <scope> -m "<description>" [-f]
 ```
 
----
-
-## 🧩 Parameters
+## Parameters
 
 | Flag             | Required | Description                                         |
 | ---------------- | -------- | --------------------------------------------------- |
-| `-t, --type`     | ✅       | Change type: `added`, `changed`, `fixed`, `removed` |
-| `-s, --scope`    | ✅       | Jira ticket or module name                          |
-| `-m, --message`  | ✅       | Description of the change                           |
-| `-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                                    |
-
----
+| `-t, --type`     | Yes      | Change type: `added`, `changed`, `fixed`, `removed` |
+| `-s, --scope`    | Yes      | Jira ticket or module name                          |
+| `-m, --message`  | Yes      | Description of the change                           |
+| `-f, --frontend` | No       | Uses `[Front-End]` instead of `[Back-End]`          |
+| `-d, --dry-run`  | No       | Preview file creation without writing               |
+| `-h, --help`     | No       | Show help                                           |
+| `-v, --version`  | No       | Show CLI version                                    |
 
-## 📝 Examples
+## Examples
 
-### Back-End Change (Default)
+Back-End (default):
 
-```
+```bash
 chlog --type added --scope JES-33 --message "Add daily consolidated JE job"
 ```
 
-Creates:
-
-```
-changelog/unreleased/added/20260213124530
-```
-
-File content:
-
-```
-[JES-33] [Back-End] Add daily consolidated JE job
-```
-
----
-
-### Front-End Change
+Front-End:
 
-```
+```bash
 chlog --type fixed --scope JES-45 --frontend --message "Fix table pagination issue"
 ```
 
-File content:
-
-```
-[JES-45] [Front-End] Fix table pagination issue
-```
-
----
-
-### Module-Based Scope
+Module scope:
 
-```
+```bash
 chlog --type changed --scope "Credit Validation" --message "Improve credit limit computation"
 ```
 
-File content:
+## Output Structure
 
-```
-[Credit Validation] [Back-End] Improve credit limit computation
-```
-
----
-
-## 📂 Directory Structure
-
-```
+```text
 changelog/
 └── unreleased/
     ├── added/
@@ -170,71 +144,21 @@ changelog/
     └── removed/
 ```
 
-Each entry is stored as a timestamp-named file:
+Entry filename format:
 
-```
+```text
 YYYYMMDDHHmmss
 ```
 
-Timezone used: **Asia/Manila**
+Timezone used: `Asia/Manila`
 
----
-
-## 🔐 Rules Enforced by CLI
+## CLI Rules
 
 - `--type` is required
 - `--scope` is required
 - `--message` is required
-- Prevents overwriting existing files
-- Automatically inserts `[Back-End]` or `[Front-End]`
-- Generates timestamp using Asia/Manila timezone
-
----
-
-## 🧠 Recommended Conventions
-
-Preferred scope format:
-
-- Jira ticket: `JES-45`
-- Module name: `"Credit Validation"`
-
-Recommended message style:
-
-- Use imperative mood
-- Start with capital letter
-- Do not end with period
-
-Example:
-
-```
-Add dealer credit validation logic
-Fix FR status blocking issue
-```
-
----
-
-## 🧪 Dry Run Mode
-
-Preview without creating file:
-
-```
-chlog --type added --scope JES-99 --message "Test entry" --dry-run
-```
-
----
-
-## 🛠 Node Version
-
-Requires:
-
-```
-Node.js >= 18
-```
-
-Runtime dependencies:
-
-- `ink`
-- `react`
+- Existing files are not overwritten
+- Layer tag is auto-added (`[Back-End]` or `[Front-End]`)
 
 ---
 
@@ -265,9 +189,3 @@ node --test
 - Output line formatting
 - Front-End vs Back-End label handling
 - Prevention of double label prefixing
-
----
-
-## 👨‍💻 Maintainer
-
-- almerleoalmazan@gmail.com

package/package.json

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