filex-cli 0.1.0 → 0.1.1

package/README.md

@@ -1,11 +1,11 @@
 # FileX
 
-A terminal CLI for safe local file operations with optional AI assistance.
+A CLI agent to modify and interact with your files.
 
 ## Installation
 
 ```bash
-npm install -g filex
+npm install -g filex-cli
 ```
 
 ## Usage
@@ -15,57 +15,65 @@ npm install -g filex
 ```bash
 # Convert images to WebP
 filex convert ./photos
-filex convert ./photos --max-width 1600 --quality 90
+filex convert ./photos --from png --to webp --quality 90
+
+# Convert with resizing
+filex convert ./photos --to jpg --max-width 1600
 
 # Resize images
 filex resize ./photos --max-width 800
 
 # Merge PDFs
 filex merge-pdfs ./documents
-filex merge-pdfs ./documents --output combined.pdf
+filex merge-pdfs ./documents --output combined.pdf --order date
 ```
 
-### AI-Driven Usage
+### AI-Powered Mode
 
-Set your Gemini API key:
-```bash
-export GEMINI_API_KEY="your-api-key"
-```
+Use natural language to describe what you want:
 
-Then use natural language:
 ```bash
-filex "convert all images here to webp and make them smaller for web"
+filex "convert all images here to webp"
 filex "resize these photos to 1200px wide" --directory ./photos
-filex "merge all the PDFs in this folder"
+filex "merge all the PDFs by date, newest first"
+filex "convert png files to jpg at 90% quality"
 ```
 
 ## Commands
 
 | Command | Description |
 |---------|-------------|
-| `convert <dir>` | Convert PNG/JPG/JPEG to WebP |
-| `resize <dir>` | Resize images to max width |
-| `merge-pdfs <dir>` | Merge all PDFs alphabetically |
+| `convert <dir>` | Convert images between formats |
+| `resize <dir>` | Resize images to a max width |
+| `merge-pdfs <dir>` | Merge all PDFs in a directory |
 
 ## Options
 
 ### convert
-- `--max-width <px>` - Maximum width in pixels
-- `--quality <1-100>` - Output quality (default: 80)
+| Option | Description | Default |
+|--------|-------------|---------|
+| `--from <format>` | Source format (png, jpg, webp, gif, tiff, avif) | all |
+| `--to <format>` | Target format (webp, png, jpg) | webp |
+| `--max-width <px>` | Maximum width in pixels | — |
+| `--quality <1-100>` | Output quality | 80 |
 
 ### resize
-- `--max-width <px>` - Maximum width in pixels (required)
+| Option | Description |
+|--------|-------------|
+| `--max-width <px>` | Maximum width in pixels *(required)* |
 
 ### merge-pdfs
-- `-o, --output <file>` - Output filename (default: merged.pdf)
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-o, --output <file>` | Output filename | merged.pdf |
+| `--order <type>` | Sort: name, name-desc, date, date-desc, random | name |
 
-## Safety Guarantees
+## Safety
 
-- ✅ **Originals are never deleted** - All operations create new files
-- ✅ **Confirmation before writes** - Preview planned actions and approve
-- ✅ **AI is sandboxed** - AI only parses intent, never touches files
-- ✅ **Graceful errors** - Clear messages, no crashes on edge cases
-- ✅ **Works without AI** - Manual commands function independently
+- ✅ **Originals preserved** — All operations create new files
+- ✅ **Preview before write** — Confirm planned actions first
+- ✅ **AI sandboxed** — AI only parses intent, never touches files directly
+- ✅ **Works offline** — Manual commands function without AI
 
 ## License