renamed.to CLI

AI-powered file renaming, document extraction, and PDF splitting from your terminal

Features • Installation • Quick Start • Commands • Watch Mode • Server

✨ Features

📦 Installation

npm install -g @renamed-to/cli

pnpm add -g @renamed-to/cli

brew install renamed-to/tap/renamed

🚀 Quick Start

# 1. Authenticate with your renamed.to account
renamed auth device

# 2. Rename files using AI
renamed rename invoice.pdf receipt.jpg

# 3. Extract data from documents
renamed extract invoice.pdf --schema invoice

# 4. Split PDFs intelligently
renamed pdf-split multi-doc.pdf --wait

$ renamed rename screenshot.png
✔ Analyzing screenshot.png...
  screenshot.png → 2024-01-15_product-mockup.png

$ renamed rename --apply *.pdf
✔ Renamed 3 files
  invoice-scan.pdf     → 2024-01-10_acme-corp-invoice-4521.pdf
  contract.pdf         → 2024-01-08_service-agreement-clientco.pdf
  receipt-photo.pdf    → 2024-01-15_amazon-order-12345.pdf

📖 Commands

🔑 Authentication

renamed auth device           # OAuth device flow (recommended)
renamed auth login --token X  # Use API token
renamed auth logout           # Remove stored credentials
renamed auth whoami           # Show current user

The device flow uses a built-in public client ID — no configuration needed.

📝 File Renaming

renamed rename <files...> [options]

# Get suggestions
renamed rename screenshot.png

# Apply automatically
renamed rename --apply *.pdf

# Organize into folders
renamed rename --apply --output-dir ~/Documents/organized ~/Downloads/*.jpg

📊 Document Extraction

renamed extract <file> [options]

# Extract invoice data
renamed extract invoice.pdf --schema invoice

# Custom fields
renamed extract doc.pdf --schema custom --fields "name,date,total"

# Output as CSV
renamed extract receipt.jpg --schema receipt --output csv

✂️ PDF Splitting

renamed pdf-split <file> [options]

# AI-powered splitting
renamed pdf-split merged.pdf --wait

# Split by invoice numbers
renamed pdf-split invoices.pdf -i "Split by invoice number" --wait

# Fixed page intervals
renamed pdf-split book.pdf --mode every-n-pages -n 10 --wait

👁️ Watch Mode

Monitor directories and automatically organize files using AI:

renamed watch <directory> [options]

renamed watch ~/Downloads --output-dir ~/Documents/organized

~/Documents/organized/
├── invoices/
│   └── 2024/
│       └── acme-invoice-001.pdf
├── receipts/
│   └── amazon-order-12345.pdf
└── contracts/
    └── service-agreement.pdf

🖥️ Server Deployment

Run as a systemd service on Linux servers:

# Install service
sudo cp examples/systemd/renamed.service /etc/systemd/system/
sudo systemctl enable renamed
sudo systemctl start renamed

# Check health
echo "" | nc -U /tmp/renamed-health.sock

See SERVER-SETUP.md for full documentation.

⚙️ Configuration

renamed config init              # Create user config
renamed config init --global     # Create system config
renamed config validate          # Validate config files
renamed config show              # Display effective configuration

watch:
  patterns: ["*.pdf", "*.jpg", "*.png"]
rateLimit:
  concurrency: 2
  retryAttempts: 3
health:
  enabled: true
  socketPath: "/tmp/renamed-health.sock"
logging:
  level: info
  json: false

🌍 Environment Variables

📋 Supported Files

🛠️ Development

git clone https://github.com/renamed-to/cli.renamed.to.git
cd cli.renamed.to
pnpm install
pnpm build
pnpm test

Website • Documentation • Issues

_{Built with ❤️ by the renamed.to team}