@amirdaraee/namewise 0.5.4 → 0.6.0

package/CHANGELOG.md

@@ -7,10 +7,61 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0] - 2026-04-02
+
+### Added
+- **Recursive Directory Scanning**: New `-r, --recursive` flag scans subdirectories
+  - Optional `--depth <n>` to cap recursion depth
+  - Example: `namewise rename ./projects --recursive --depth 2 --dry-run`
+- **Undo Command**: New `namewise undo` reverses the most recent rename session
+  - Sessions stored in `~/.namewise/history.json` (append-only audit log)
+  - `namewise undo --list` shows the last 10 sessions with their IDs
+  - `namewise undo <session-id>` undoes a specific past session
+  - Warns and skips (without erroring) if a file has already been moved
+- **Cascading Config File**: Project- and user-level config support
+  - `~/.namewise.json` sets user-wide defaults
+  - `<targetDir>/.namewise.json` overrides per project
+  - CLI flags override both; all keys are optional
+  - Supports: `provider`, `case`, `template`, `name`, `date`, `maxSize`, `model`, `baseUrl`, `concurrency`, `recursive`, `depth`, `output`
+- **Concurrency Control**: New `--concurrency <n>` flag (default: 3)
+  - Files are processed in parallel up to the configured limit
+  - Implemented with a zero-dependency semaphore
+- **JSON Rename Report**: New `--output <path>` flag writes a full report after each run
+  - Includes timestamp, directory, dry-run flag, summary counts, and per-file results
+
+### Changed
+- **Conflict Auto-Numbering**: Replaces the old "file already exists" error
+  - When the suggested name is taken, automatically tries `-2`, `-3` … up to `-99`
+  - Example: `report.pdf` → `report-2.pdf` if `report.pdf` already exists
+
+### Technical
+- Added `src/utils/config-loader.ts` and `src/utils/history.ts` as thin, focused modules
+- Added `src/cli/undo.ts` for undo command logic
+- 103 new tests across 11 new/updated test files; total now 428 tests (36 files)
+
+### Examples
+```bash
+# Recursive scan with depth limit
+namewise rename ./projects --recursive --depth 2 --dry-run
+
+# Save defaults to ~/.namewise.json
+echo '{"provider":"claude","case":"snake_case","concurrency":5}' > ~/.namewise.json
+
+# Save a rename report
+namewise rename ./documents --output ./report.json
+
+# Undo the last session
+namewise undo
+
+# List and undo a specific session
+namewise undo --list
+namewise undo 2026-04-02T10:30:00.000Z
+```
+
 ## [0.5.4] - 2026-03-31
 
 ### Improved
-- **🧪 Test Coverage**: Achieved 100% coverage across all metrics (statements, branches, functions, lines)
+- **Test Coverage**: Achieved 100% coverage across all metrics (statements, branches, functions, lines)
   - 325 tests across 26 test files
   - Added tests for all error branches including non-Error exception paths
   - Full coverage for scanned PDF handling, folder-based categorization, and naming convention truncation
@@ -19,7 +70,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.5.0] - 2025-11-10
 
 ### Added
-- **📄 Scanned PDF Support**: Full support for image-only (scanned) PDFs with vision AI
+- **Scanned PDF Support**: Full support for image-only (scanned) PDFs with vision AI
   - Automatic detection of scanned PDFs (documents with minimal or no text)
   - Converts first page to image and sends to AI for content analysis
   - Intelligent image optimization to stay under Claude's 5MB limit
@@ -28,11 +79,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Smart size calculation to ensure API compatibility
 
 ### Enhanced
-- **🔄 PDF Processing**: Replaced PDF.js with pdf-to-png-converter for better Node.js compatibility
+- **PDF Processing**: Replaced PDF.js with pdf-to-png-converter for better Node.js compatibility
   - Resolves canvas rendering issues in Node.js environment
   - More reliable PDF-to-image conversion
   - Better error handling and debugging
-- **🤖 AI Model**: Updated to Claude Sonnet 4.5 (claude-sonnet-4-5-20250929)
+- **AI Model**: Updated to Claude Sonnet 4.5 (claude-sonnet-4-5-20250929)
   - Latest Claude model with enhanced vision capabilities
   - Improved accuracy for document analysis
   - Better understanding of complex document layouts
@@ -44,9 +95,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Improved error logging with detailed stack traces
 
 ### Fixed
-- **🐛 Critical**: Fixed "Image or Canvas expected" errors when processing scanned PDFs
-- **🐛 Critical**: Fixed "image exceeds 5 MB maximum" errors with large scanned documents
-- **🐛 Model**: Fixed deprecated model warnings by updating to latest Claude API
+- **Critical**: Fixed "Image or Canvas expected" errors when processing scanned PDFs
+- **Critical**: Fixed "image exceeds 5 MB maximum" errors with large scanned documents
+- **Model**: Fixed deprecated model warnings by updating to latest Claude API
 
 ### Examples
 ```bash
@@ -64,27 +115,27 @@ namewise rename ./documents --dry-run
 ## [0.4.1] - 2025-09-15
 
 ### Enhanced
-- **🔧 Reliability Improvements**: Enhanced stability and consistency across all AI providers
-- **📋 Documentation**: Improved examples and usage documentation
+- **Reliability Improvements**: Enhanced stability and consistency across all AI providers
+- **Documentation**: Improved examples and usage documentation
 
 ## [0.4.0] - 2025-09-15
 
 ### Added
-- **🤖 Local LLM Provider Support**: Full integration with local AI services
+- **Local LLM Provider Support**: Full integration with local AI services
   - **Ollama**: Local LLM support with customizable models (llama3.1, codellama, etc.)
   - **LMStudio**: Local model hosting with OpenAI-compatible API
   - Support for custom base URLs and model selection
   - Availability checking and model listing for local providers
 
 ### Enhanced
-- **🎯 Intelligent Person Name Detection**: Major AI prompting improvements
+- **Intelligent Person Name Detection**: Major AI prompting improvements
   - AI now extracts person names from document content and places them at filename beginning
   - Smart folder name filtering to ignore irrelevant names like "no", "temp", "downloads"
   - Enhanced prompts that focus on document content rather than metadata
   - Support for detecting visa applications, contracts, medical records, certificates
 
 ### Architecture
-- **📋 Centralized Prompt System**: Single source of truth for all AI prompts
+- **Centralized Prompt System**: Single source of truth for all AI prompts
   - Model-agnostic prompting that works across Claude, OpenAI, LMStudio, and Ollama
   - Consolidated prompt building in `/src/utils/ai-prompts.ts`
   - Consistent behavior across all AI providers
@@ -110,18 +161,18 @@ namewise rename ./files --provider lmstudio --base-url http://localhost:1234 --m
 ## [0.3.1] - 2025-09-05
 
 ### Security
-- **🔒 Vulnerability Fix**: Replaced vulnerable `xlsx` package with secure `exceljs`
+- **Vulnerability Fix**: Replaced vulnerable `xlsx` package with secure `exceljs`
 - Enhanced Excel file parsing with improved security and reliability
 
 ### Infrastructure
-- **⚙️ CI/CD Improvements**: Enhanced GitHub Actions workflows
+- **CI/CD Improvements**: Enhanced GitHub Actions workflows
 - Updated Node.js versions in CI pipelines
 - Improved test workflow reliability and build process
 
 ## [0.3.0] - 2025-09-05
 
 ### Added
-- **🎯 Personal File Templates**: Customizable templates for different file categories
+- **Personal File Templates**: Customizable templates for different file categories
   - `document`: Personal docs with name and date (e.g., `driving-license-amirhossein-20250213.pdf`)
   - `movie`: Movies with release year (e.g., `the-dark-knight-2008.mkv`)
   - `music`: Music with artist names (e.g., `the-beatles-hey-jude.mp3`)
@@ -129,14 +180,14 @@ namewise rename ./files --provider lmstudio --base-url http://localhost:1234 --m
   - `photo`: Photos with personal info (e.g., `vacation-paris-john-20240715.jpg`)
   - `book`: Books with author names (e.g., `george-orwell-1984.pdf`)
   - `general`: General files without special formatting
-- **🤖 Smart File Categorization**: Automatically detects file type based on extension and content
-- **👤 Personal Name Integration**: `-n, --name` option to include your name in documents
-- **📅 Flexible Date Formats**: `-d, --date` option with formats:
+- **Smart File Categorization**: Automatically detects file type based on extension and content
+- **Personal Name Integration**: `-n, --name` option to include your name in documents
+- **Flexible Date Formats**: `-d, --date` option with formats:
   - `YYYY-MM-DD`: 2025-09-05
   - `YYYY`: 2025
   - `YYYYMMDD`: 20250905
   - `none`: No date (default)
-- **📂 Category Templates**: `-t, --template` option to specify file category or use auto-detection
+- **Category Templates**: `-t, --template` option to specify file category or use auto-detection
 
 ### Enhanced
 - AI prompts now include category-specific instructions for better filename generation

package/README.md

@@ -1,12 +1,12 @@
 # Namewise
 
-[![Tests](https://img.shields.io/badge/tests-65%20passing-brightgreen.svg)](#-testing--development)
-[![Coverage](https://img.shields.io/badge/coverage-90%25%20branches-brightgreen.svg)](#-testing--development)
+[![Tests](https://img.shields.io/badge/tests-428%20passing-brightgreen.svg)](#testing--development)
+[![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](#testing--development)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue.svg)](https://www.typescriptlang.org/)
-[![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
+[![Node.js](https://img.shields.io/badge/Node.js-20+-green.svg)](https://nodejs.org/)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
 
-🤖 **AI-Powered File Renaming CLI Tool**
+**AI-Powered File Renaming CLI Tool**
 
 Automatically rename files based on their content using AI providers (Claude, OpenAI, Ollama, LMStudio). Transform messy filenames like `document1.pdf` or `IMG_20240315_143022.pdf` into descriptive names like `project-requirements-document.pdf` or `quarterly-sales-report-q4-2023.pdf`.
 
@@ -16,16 +16,20 @@ Automatically rename files based on their content using AI providers (Claude, Op
 
 - **AI-Powered Renaming**: Uses cloud providers (Claude, OpenAI) or local LLMs (Ollama, LMStudio) to generate descriptive filenames
 - **Privacy First**: Local LLM support means your files never leave your machine
-- **Cost Effective**: Use free local models or pay-per-use cloud APIs
+- **Recursive Scanning**: Scan nested directories with an optional depth limit
+- **Undo Support**: Reverse any previous rename session via `namewise undo`
+- **Config File**: Set persistent defaults in `~/.namewise.json` or per-project `.namewise.json`
+- **Concurrency Control**: Process multiple files in parallel with a configurable limit
+- **Conflict Auto-Numbering**: When a target name is taken, automatically appends `-2`, `-3`, etc.
+- **JSON Report Output**: Save a full rename report to a file with `--output`
 - **Personal File Templates**: Customizable templates for different file categories (documents, movies, music, series, photos, books)
 - **Smart Categorization**: Automatic file type detection or manual category selection
 - **Naming Convention Options**: 6 different formats (kebab-case, snake_case, camelCase, PascalCase, lowercase, UPPERCASE)
 - **Multiple File Types**: Supports PDF, DOCX, DOC, XLSX, XLS, TXT, MD, and RTF files
 - **Dry Run Mode**: Preview changes before renaming files
-- **Conflict Detection**: Prevents overwriting existing files
 - **Size Limits**: Configurable maximum file size limits
 
-## 🚀 Quick Start
+## Quick Start
 
 ```bash
 # Clone and setup
@@ -34,14 +38,14 @@ cd namewise
 npm install
 npm run build
 
-# Rename files (dry run first)
+# Preview renames (recommended first)
 npx namewise rename ./my-documents --dry-run --provider claude
 
-# Actually rename with your API key
+# Actually rename
 npx namewise rename ./my-documents --provider claude --api-key your-api-key
 ```
 
-## 📦 Installation
+## Installation
 
 ### Option 1: Clone and Build
 ```bash
@@ -49,20 +53,22 @@ git clone https://github.com/amirdaraee/namewise.git
 cd namewise
 npm install
 npm run build
-npm link  # Optional: for global usage
+npm link # Optional: for global usage
 ```
 
 ### Option 2: Direct Download
 Download the latest release from [GitHub Releases](https://github.com/amirdaraee/namewise/releases)
 
-## 📖 Usage
+## Usage
 
 ### Command Structure
 ```bash
-namewise rename <directory> [options]
+namewise rename [directory] [options]
+namewise undo [session-id] [options]
 ```
 
 ### Options Reference
+
 | Option | Description | Default |
 |--------|-------------|---------|
 | `--provider` | AI provider (`claude`, `openai`, `ollama`, `lmstudio`) | `claude` |
@@ -75,15 +81,47 @@ namewise rename <directory> [options]
 | `--date` | Date format (YYYY-MM-DD, YYYY, YYYYMMDD, none) | `none` |
 | `--dry-run` | Preview changes without renaming | `false` |
 | `--max-size` | Maximum file size in MB | `10` |
+| `-r, --recursive` | Recursively scan subdirectories | `false` |
+| `--depth <n>` | Maximum recursion depth (requires `--recursive`) | Unlimited |
+| `--concurrency <n>` | Files to process in parallel | `3` |
+| `--output <path>` | Save rename report as JSON to this path | - |
+
+### Undo Options
+
+| Option | Description |
+|--------|-------------|
+| `--list` | List recent rename sessions with their IDs |
+| `[session-id]` | Undo a specific session by ID (default: most recent) |
 
-### 💡 Examples
+### Examples
 
-**Basic usage (general template, no personalization):**
+**Basic usage:**
 ```bash
 namewise rename ./documents --dry-run
 # Result: quarterly-financial-report.pdf
 ```
 
+**Recursive scan with depth limit:**
+```bash
+namewise rename ./projects --recursive --depth 2 --dry-run
+```
+
+**Save a JSON report:**
+```bash
+namewise rename ./documents --output ./report.json
+```
+
+**Undo the last rename session:**
+```bash
+namewise undo
+```
+
+**List and undo a specific session:**
+```bash
+namewise undo --list
+namewise undo 2026-04-02T10:30:00.000Z
+```
+
 **Personal documents with your name and date:**
 ```bash
 namewise rename ./documents --template document --name "john" --date "YYYYMMDD" --dry-run
@@ -98,80 +136,87 @@ namewise rename ./movies --template auto --dry-run
 
 **TV series with season/episode detection:**
 ```bash
-namewise rename ./shows --template auto --dry-run  
+namewise rename ./shows --template auto --dry-run
 # Result: breaking-bad-s01e01.mkv
 ```
 
-**Music with artist names:**
-```bash
-namewise rename ./music --template music --dry-run
-# Result: the-beatles-hey-jude.mp3
-```
-
 **Snake case naming convention:**
 ```bash
 namewise rename ./docs --case snake_case --dry-run
 # Result: project_requirements_document.pdf
 ```
 
-**Local LLMs (Privacy-First, No API Keys):**
+**Local LLMs (no API key required):**
 ```bash
 # Ollama - requires 'ollama serve' running
 namewise rename ./documents --provider ollama --dry-run
-# Result: quarterly-financial-report.pdf
-
-# Custom Ollama model
-namewise rename ./code --provider ollama --model codellama --dry-run
-# Result: user-authentication-service.js
 
 # LMStudio - requires local server enabled
 namewise rename ./contracts --provider lmstudio --dry-run
-# Result: employment-agreement-template.docx
-
-# Remote Ollama server
-namewise rename ./files --provider ollama --base-url http://192.168.1.100:11434 --model llama3.1
 ```
 
-**Cloud Providers (API Keys Required):**
+**Cloud providers:**
 ```bash
-# Claude (recommended for accuracy)
-export CLAUDE_API_KEY=your-key
+export ANTHROPIC_API_KEY=your-key
 namewise rename ./documents --provider claude --dry-run
 
-# OpenAI  
 export OPENAI_API_KEY=your-key
-namewise rename ./files --provider openai --max-size 20 --dry-run
+namewise rename ./files --provider openai --dry-run
 ```
 
-**Before and After Example:**
+**Before and after:**
 ```
-📁 Before:
+Before:
 ├── IMG_20240315_143022.pdf
 ├── document1.docx
 ├── Report Q4 2023 FINAL FINAL.xlsx
 
-📁 After:
+After:
 ├── quarterly-financial-report-q4-2023.pdf
 ├── project-requirements-specification.docx
 ├── annual-sales-performance-summary.xlsx
 ```
 
-## 📄 Supported File Types
+## Config File
 
-| Type | Extensions | Parser |
-|------|------------|---------|
-| 📄 PDF Documents | `.pdf` | pdf-extraction |
-| 📝 Microsoft Word | `.docx`, `.doc` | mammoth |
-| 📊 Microsoft Excel | `.xlsx`, `.xls` | xlsx |
-| 📋 Text Files | `.txt`, `.md`, `.rtf` | Native fs |
+Set persistent defaults so you don't have to repeat flags on every run.
 
-## 🎯 File Templates
+**User-wide defaults** (`~/.namewise.json`):
+```json
+{
+  "provider": "claude",
+  "case": "snake_case",
+  "concurrency": 5
+}
+```
 
-Choose from specialized templates for different file types:
+**Per-project overrides** (`<targetDir>/.namewise.json`):
+```json
+{
+  "template": "document",
+  "name": "alice",
+  "date": "YYYYMMDD"
+}
+```
+
+Priority order (highest to lowest): CLI flags > project config > user config.
+
+Supported keys: `provider`, `case`, `template`, `name`, `date`, `maxSize`, `model`, `baseUrl`, `concurrency`, `recursive`, `depth`, `output`.
+
+## Supported File Types
+
+| Type | Extensions | Parser |
+|------|------------|--------|
+| PDF Documents | `.pdf` | pdf-extraction |
+| Microsoft Word | `.docx`, `.doc` | mammoth |
+| Microsoft Excel | `.xlsx`, `.xls` | exceljs |
+| Text Files | `.txt`, `.md`, `.rtf` | Native fs |
+
+## File Templates
 
 | Template | Pattern | Example Output | When to Use |
 |----------|---------|----------------|-------------|
-| `general` | `{content}` | `meeting-notes-q4-2024.pdf` | Default - simple descriptive names |
+| `general` | `{content}` | `meeting-notes-q4-2024.pdf` | Default — simple descriptive names |
 | `document` | `{content}-{name}-{date}` | `driving-license-john-20250905.pdf` | Personal documents, contracts, certificates |
 | `movie` | `{content}-{year}` | `the-dark-knight-2008.mkv` | Movie files with release year |
 | `series` | `{content}-s{season}e{episode}` | `breaking-bad-s01e01.mkv` | TV series episodes |
@@ -180,97 +225,70 @@ Choose from specialized templates for different file types:
 | `book` | `{author}-{content}` | `george-orwell-1984.pdf` | Books and ebooks |
 | `auto` | *Automatic* | *Varies by detected type* | Let AI detect and choose best template |
 
-## 🔑 AI Provider Setup
+## AI Provider Setup
 
-### 🏠 Local LLMs (Privacy-First, No API Keys)
+### Local LLMs (no API keys required)
 
-**Ollama** - Recommended for privacy
+**Ollama**
 1. Install: Download from [ollama.ai](https://ollama.ai)
 2. Start server: `ollama serve`
-3. Pull model: `ollama pull llama3.1` (or your preferred model)
+3. Pull a model: `ollama pull llama3.1`
 4. Use: `--provider ollama`
 
-**LMStudio** - User-friendly interface
+**LMStudio**
 1. Install: Download from [lmstudio.ai](https://lmstudio.ai)
 2. Download and load a model in LMStudio
-3. Enable "Local Server" mode in LMStudio
+3. Enable "Local Server" mode
 4. Use: `--provider lmstudio`
 
-### ☁️ Cloud Providers (Require API Keys)
+### Cloud Providers (API keys required)
 
-**Claude (Anthropic)** - Recommended for accuracy
+**Claude (Anthropic)** — recommended for accuracy
 1. Visit [Anthropic Console](https://console.anthropic.com/)
-2. Create an account and generate an API key
-3. Set as environment variable: `export CLAUDE_API_KEY=your-key`
+2. Generate an API key
+3. `export ANTHROPIC_API_KEY=your-key`
 
 **OpenAI**
-1. Visit [OpenAI Platform](https://platform.openai.com/api-keys)  
+1. Visit [OpenAI Platform](https://platform.openai.com/api-keys)
 2. Create an API key
-3. Set as environment variable: `export OPENAI_API_KEY=your-key`
-
-### 🚀 Quick Start by Privacy Preference
-
-**Maximum Privacy (Local Processing):**
-```bash
-# Setup Ollama
-ollama serve
-ollama pull llama3.1
-
-# Use locally - no data leaves your machine
-namewise rename ./documents --provider ollama --dry-run
-```
+3. `export OPENAI_API_KEY=your-key`
 
-**Balanced (Cloud with API key):**
-```bash
-# Use Claude for best accuracy
-export CLAUDE_API_KEY=your-key
-namewise rename ./documents --provider claude --dry-run
-```
+## How It Works
 
-> 💡 **Tip**: Local LLMs require no API keys and keep your data private. Cloud providers may offer better accuracy but require API keys and send data externally.
+1. **File Discovery**: Scans directory (recursively if `--recursive`) for supported file types
+2. **Content Extraction**: Uses specialized parsers to extract text; falls back to vision AI for scanned PDFs
+3. **AI Processing**: Sends content to the configured AI provider for filename suggestions
+4. **Template & Convention**: Applies the chosen category template and naming convention
+5. **Conflict Resolution**: If the target name exists, auto-numbers (`-2`, `-3`, …)
+6. **Rename / Preview**: Renames files on disk, or shows a preview in dry-run mode
+7. **History**: Saves the session to `~/.namewise/history.json` for later undo
 
-## ⚙️ How It Works
+## Safety Features
 
-```mermaid
-graph LR
-    A[📁 Scan Directory] --> B[📄 Parse Content]
-    B --> C[🤖 AI Analysis]
-    C --> D[✏️ Generate Name]
-    D --> E[✅ Validate & Rename]
-```
+- **Dry Run Mode**: Always preview changes first with `--dry-run`
+- **Undo**: Reverse any session with `namewise undo`
+- **Conflict Auto-Numbering**: Never overwrites an existing file
+- **File Size Limits**: Skips files above `--max-size`
+- **Extension Preservation**: Original file extensions are never changed
+- **Comprehensive Testing**: 428 tests with 100% coverage
 
-1. **📁 File Discovery**: Scans directory for supported file types
-2. **📄 Content Extraction**: Uses specialized parsers to extract text content
-3. **🤖 AI Processing**: Sends content to AI provider for filename suggestions
-4. **✏️ Filename Generation**: Creates clean, kebab-case names
-5. **✅ Safety Checks**: Validates conflicts and performs renaming
-
-## 🛡️ Safety Features
-
-- ✅ **Dry Run Mode**: Always preview changes first
-- ✅ **File Size Limits**: Prevents processing overly large files  
-- ✅ **Conflict Detection**: Won't overwrite existing files
-- ✅ **Error Handling**: Graceful handling of parsing and API errors
-- ✅ **Extension Preservation**: Keeps original file extensions
-- ✅ **Comprehensive Testing**: 65 tests with 90%+ branch coverage
-
-## 🧪 Testing & Development
+## Testing & Development
 
 ```bash
 # Development
-npm run dev              # Run in development mode
-npm run build           # Build TypeScript
-npm start               # Run built version
-
-# Testing  
-npm test                # Run all tests
-npm run test:coverage   # Coverage report
-npm run test:ui         # Interactive test UI
+npm run dev          # Run in development mode
+npm run build        # Build TypeScript
+npm start            # Run built version
+
+# Testing
+npm test             # Run all tests (watch mode)
+npm run test:run     # Run tests once
+npm run test:coverage # Coverage report
+npm run test:unit    # Unit tests only
+npm run test:integration # Integration tests only
 ```
 
-The project includes comprehensive tests with 65 test cases covering all functionality except AI API calls (which are mocked).
-
-## 🤝 Contributing
+## Contributing
 
 1. Fork the repository
 2. Create a feature branch: `git checkout -b feature-name`
@@ -278,50 +296,45 @@ The project includes comprehensive tests with 65 test cases covering all functio
 4. Run tests: `npm test`
 5. Submit a pull request
 
-## 📋 Requirements
+## Requirements
 
-- **Node.js**: 18.0.0 or higher
-- **TypeScript**: 5.0.0 or higher  
+- **Node.js**: 20.0.0 or higher
 - **AI Provider**: Choose one:
   - **Local**: Ollama or LMStudio (no API key needed)
   - **Cloud**: Claude (Anthropic) or OpenAI API key
 
-## 🐛 Troubleshooting
+## Troubleshooting
 
 <details>
 <summary>Common Issues</summary>
 
 **PDF parsing errors:**
-- Ensure PDF is not password protected
-- Check file is not corrupted
-- Try reducing max-size limit
+- Ensure the PDF is not password protected
+- Check the file is not corrupted
+- Try reducing the `--max-size` limit
 
-**API errors (Cloud providers):**
-- Verify API key is valid
-- Check internet connection
+**API errors (cloud providers):**
+- Verify the API key is valid
+- Check your internet connection
 - Ensure sufficient API credits
 
 **Local LLM connection errors:**
 - Ensure Ollama server is running (`ollama serve`)
 - Check LMStudio local server is enabled
 - Verify correct base URL and port
-- Confirm model is loaded/available
+- Confirm the model is loaded and available
 
 **Permission errors:**
 - Check file permissions
 - Run with appropriate user privileges
-- Ensure files aren't in use by other applications
+- Ensure files are not open in another application
 
 </details>
 
-## 📝 License
+## License
 
-[MIT License](./LICENSE) - Feel free to use, modify, and distribute this project.
+[MIT License](./LICENSE) — Feel free to use, modify, and distribute this project.
 
 ---
 
-<div align="center">
-<strong>⭐ Star this repo if it helped you organize your files! ⭐</strong>
-
 [Report Bug](https://github.com/amirdaraee/namewise/issues) • [Request Feature](https://github.com/amirdaraee/namewise/issues)
-</div>

package/dist/cli/commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGpC,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CA4DpD"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAIpC,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CA8EpD"}