Renamed.to logorenamed.to
Back to renamed.to
Documentation

Command Line Interface

CLI Documentation

AI-powered file automation from your terminal. Rename thousands of files, extract document data, and split PDFs with simple commands.

Quick Start

Try instantly with npx — no installation required:

Terminal
$ npx @renamed-to/cli watch ~/Downloads --output-dir ~/Organized

Or install globally for all features:

# Install with pnpm (recommended)
$ pnpm add -g @renamed-to/cli

# Then authenticate
$ renamed auth login

Commands

rename

AI-powered file renaming

extract

Extract structured data to JSON/CSV

pdf-split

Split multi-page PDFs intelligently

watch

Monitor folders and auto-process files

service

Deploy as a systemd service

auth

Manage authentication

config

Manage configuration files

doctor

Diagnose setup and connectivity

Example Workflow

Process a folder of messy documents into organized, searchable files:

# Preview what will be renamed
$ renamed rename ./documents/

# Apply the changes
$ renamed rename ./documents/ --apply

Analyzing 47 files...
✓ IMG_4521.pdf → 2026-01-15_AcmeCorp_Invoice.pdf
✓ scan0042.pdf → 2026-01-14_Receipt_Starbucks.pdf
✓ document.pdf → 2026-01-13_Contract_NDA_TechCorp.pdf
Done! 47 files renamed in 2.3s

Global Options

These options work with all commands:

--json

Output results as JSON for scripting.

-q, --quiet

Suppress all output except errors.

-y, --yes

Skip confirmation prompts.

--no-input

Disable interactive prompts. Useful for CI/CD.

--timeout <ms>

API request timeout in milliseconds.

--retry <n>

Number of retry attempts for failed requests.

--on-conflict <strategy>

How to handle filename conflicts: fail, skip, suffix

-h, --help

Show help for a command.

Environment Variables

RENAMED_TOKEN — API token for authentication (alternative to auth login)

RENAMED_CLIENT_ID — Custom OAuth client ID for enterprise SSO

RENAMED_CLIENT_SECRET — Custom OAuth client secret for enterprise SSO

RENAMED_JSON=1 — Enable JSON output (equivalent to --json)

RENAMED_QUIET=1 — Enable quiet mode (equivalent to --quiet)

CI=1 — Detected automatically. Enables --no-input and machine-friendly output.

Supported File Types

PDF, JPG, JPEG, PNG, TIFF — max 25MB per file.

Resources

GitHub RepositoryCLI Landing Page