All commands are available via file-organizer or the short alias fo.
These options apply to every command and may be passed before or after the command name:
| Flag | Short | Description |
|---|---|---|
--verbose |
-v |
Enable verbose output |
--dry-run |
Preview changes without executing | |
--json |
Output results as JSON | |
--yes |
-y |
Auto-confirm all prompts |
--no-interactive |
Disable interactive prompts | |
--help |
Show help and exit |
Show the application version.
file-organizer versionOrganize files in a directory using AI models.
Usage:
file-organizer organize INPUT_DIR OUTPUT_DIR [OPTIONS]Arguments:
INPUT_DIR— Directory containing files to organizeOUTPUT_DIR— Destination directory for organized files
Options:
--dry-run— Preview without moving files--verbose, -v— Verbose output--max-workers INTEGER— Cap parallel worker count--sequential— Force single-worker sequential processing--no-vision,--text-only— Disable vision model loading and use extension fallback for images--prefetch-depth INTEGER— Parallel task queue-ahead depth (0disables prefetch queueing)--no-prefetch— Backward-compatible alias for--prefetch-depth 0
Examples:
# Organize ~/Downloads into ~/Organized
file-organizer organize ~/Downloads ~/Organized
# Preview what would happen (no files moved)
file-organizer organize ~/Downloads ~/Organized --dry-run
# Verbose output
file-organizer organize ~/Downloads ~/Organized --verbose
# Limit CPU/IO pressure on constrained machines
file-organizer organize ~/Downloads ~/Organized --max-workers 2 --prefetch-depth 1
# Strict sequential mode for deterministic debugging
file-organizer organize ~/Downloads ~/Organized --sequential
# Disable AI vision processing and use extension-based image fallback
file-organizer organize ~/Downloads ~/Organized --no-vision
# Backward-compatible alias
file-organizer organize ~/Downloads ~/Organized --no-prefetchNote: To set a default methodology (PARA, Johnny Decimal, etc.) or override AI models, use
file-organizer config editbefore running organize.
Preview how files would be organized without moving them (dry-run shortcut).
Usage:
file-organizer preview INPUT_DIRExamples:
file-organizer preview ~/Downloads
fo preview ~/DownloadsStart the File Organizer web server and API.
Usage:
file-organizer serve [OPTIONS]Options:
--host TEXT— Bind address (default:0.0.0.0)--port INTEGER— Port number (default:8000)--reload— Auto-reload on code changes (development mode)--workers INTEGER— Number of worker processes (default:1)
Examples:
# Start with defaults (port 8000, all interfaces)
file-organizer serve
# Development mode with auto-reload
file-organizer serve --reload
# Custom host and port
file-organizer serve --host 127.0.0.1 --port 9000
# Production with multiple workers
file-organizer serve --workers 4Access: Once running, open
http://localhost:8000/ui/in your browser.
Search for files by name pattern with optional type filtering.
Usage:
file-organizer search QUERY [DIRECTORY] [OPTIONS]Arguments:
QUERY— Search query (glob pattern like*.pdfor keyword likereport)DIRECTORY— Directory to search in (default: current directory)
Options:
--type, -t TEXT— Filter by type:text,image,video,audio,archive--limit, -n INTEGER— Max results to show (default: 50)--recursive / --no-recursive— Search subdirectories (default: recursive)--json— Output as JSON array
Examples:
# Search by glob pattern
file-organizer search "*.pdf" ~/Documents
# Keyword search (case-insensitive)
file-organizer search "report" ~/Documents
# Filter by type
file-organizer search "*" ~/Pictures --type image
# Non-recursive, limited results
file-organizer search "*.log" /var/log --no-recursive --limit 10
# JSON output for scripting
file-organizer search "*.py" ./src --jsonAnalyze a file using AI and show its description, category, and confidence score.
Usage:
file-organizer analyze FILE [OPTIONS]Arguments:
FILE_PATH— Path to the file to analyze
Options:
--verbose, -v— Show additional details (model name, processing time, content length)--json— Output as JSON
Examples:
# Basic analysis
file-organizer analyze ~/Documents/report.pdf
# Verbose output
file-organizer analyze ~/Documents/report.pdf --verbose
# JSON output for scripting
file-organizer analyze ~/Documents/report.pdf --jsonNote: Requires Ollama to be installed and running with a text model available.
Launch the interactive Terminal User Interface.
file-organizer tuiDetect hardware capabilities and print model-sizing recommendations.
Usage:
file-organizer hardware-info [OPTIONS]Options:
--json— Output the hardware profile as JSON
Examples:
# Human-readable hardware summary
file-organizer hardware-info
# JSON output for automation or debugging
file-organizer hardware-info --jsonWhy it exists: This command exposes the same hardware profile the app uses to choose sane defaults for model size and worker count, which helps explain performance differences across machines.
Undo file operations.
Usage:
file-organizer undo [OPTIONS]Options:
--operation-id INTEGER— Specific operation ID to undo--transaction-id TEXT— Transaction ID to undo (undoes all operations in a transaction)--dry-run— Preview without executing--verbose, -v— Verbose output
Examples:
# Undo the last operation
file-organizer undo
# Undo a specific operation
file-organizer undo --operation-id 42
# Undo all operations in a transaction
file-organizer undo --transaction-id abc123Redo previously undone file operations.
Usage:
file-organizer redo [OPTIONS]Options:
--operation-id INTEGER— Specific operation ID to redo--dry-run— Preview without executing--verbose, -v— Verbose output
View operation history.
Usage:
file-organizer history [OPTIONS]Options:
--limit INTEGER— Maximum number of operations to show (default: 10)--type TEXT— Filter by operation type--status TEXT— Filter by status--stats— Show statistics summary--verbose, -v— Verbose output
Examples:
file-organizer history
file-organizer history --limit 50
file-organizer history --statsDisplay storage analytics dashboard.
Usage:
file-organizer analytics [DIRECTORY] [OPTIONS]Arguments:
DIRECTORY— Directory to analyze (optional; defaults to configured workspace)
Options:
--verbose, -v— Verbose output
Examples:
file-organizer analytics
file-organizer analytics ~/DocumentsMeasure file processing performance with statistical output, warmup exclusion, suite selection, and baseline comparison with regression detection.
Run a performance benchmark on a directory of files.
Usage:
file-organizer benchmark run [INPUT_PATH] [OPTIONS]Arguments:
INPUT_PATH— Path to files to benchmark (default:tests/fixtures/)
Options:
--iterations INTEGER, -i INTEGER— Number of measured iterations (default:10, min:1)--warmup INTEGER, -w INTEGER— Warmup iterations excluded from statistics (default:3, min:0)--suite TEXT, -s TEXT— Benchmark suite to run:io,text,vision,audio,pipeline,e2e(default:io)io: file stat/read overhead baselinetext:TextProcessor.process_file()path with deterministic benchmark model stubsvision:VisionProcessor.process_file()path with deterministic benchmark model stubsaudio: audio metadata extraction + rule-based classification path (uses synthetic metadata only when optional extractor dependencies are unavailable)pipeline:PipelineOrchestrator.process_batch()staged pathe2e: fullFileOrganizer.organize()pass with real writes in an isolated temp workspace
--json— Output results as JSON instead of a Rich table--compare PATH— Path to baseline JSON file for regression comparison
Output Metrics (JSON schema):
suite— Suite name that was runeffective_suite— Effective suite semantics used for execution (for example,audiomay degrade toiosemantics when no audio candidates are available)degraded—truewhen the run used degraded semantics (skip/fallback), otherwisefalsedegradation_reasons— Stable machine-readable degradation reason codes; empty whendegradedisfalserunner_profile_version— Benchmark runner semantics profile version for baseline compatibility checksfiles_count— Number of files actually processed by the selected suite semanticshardware_profile— Hardware detection info (CPU, memory, GPU)results.median_ms— Median iteration time in millisecondsresults.p95_ms— 95th percentile iteration timeresults.p99_ms— 99th percentile iteration timeresults.stddev_ms— Standard deviation of iteration timesresults.throughput_fps— Throughput in files per second (based on median)results.iterations— Number of measured iterations
When --compare is used, JSON also includes:
comparison.deltas_pct.*— Percentage delta versus the baseline for each metriccomparison.regression—trueif current p95 crossed the regression thresholdcomparison.threshold— Threshold multiplier used for regression detection — fixed at1.2for the CLI (not user-configurable; emitted in the JSON for consumer reference)comparison_profile_warning— Present when comparing against a baseline built with a differentrunner_profile_version
Regression Detection:
When --compare is provided, compares current results against a baseline JSON
file. Flags a regression if p95 exceeds 120% of the baseline p95.
Examples:
# Benchmark files in Downloads with default settings
file-organizer benchmark run ~/Downloads
# Run with 5 iterations, no warmup, JSON output
file-organizer benchmark run ~/Documents --iterations 5 --warmup 0 --json
# Run text suite and compare against baseline
file-organizer benchmark run tests/fixtures/ --suite text --json --compare baseline.json
# Save baseline for future comparison
file-organizer benchmark run tests/fixtures/ --json > baseline.jsonAudio suite behavior note:
audiointentionally differs fromtext/vision: it exercises real metadata extraction + classification and only falls back to synthetic metadata when optional extractor dependencies are unavailable.
Manage configuration profiles.
Display the current configuration profile.
file-organizer config show [--profile PROFILE]Options:
--profile TEXT— Profile name (default:default)
List all available configuration profiles.
file-organizer config listEdit a configuration profile.
file-organizer config edit [OPTIONS]Options:
--profile TEXT— Profile name to edit (default:default)--text-model TEXT— Set the text model name--vision-model TEXT— Set the vision model name--temperature FLOAT— Set temperature (0.0–1.0)--device TEXT— Set device (auto,cpu,cuda,mps,metal)--methodology TEXT— Set default methodology (none,para,jd)
Examples:
file-organizer config show
file-organizer config show --profile work
file-organizer config edit --text-model qwen2.5:3b-instruct-q4_K_M
file-organizer config edit --device cuda --methodology para
file-organizer config edit --profile work --temperature 0.7Manage AI models via Ollama.
List available models with their install status.
file-organizer model list [--type TYPE]Options:
--type TEXT— Filter by type:text,vision, oraudio
Download a model via Ollama.
file-organizer model pull MODEL_NAMEArguments:
NAME— Model name to download (e.g.qwen2.5:3b-instruct-q4_K_M)
Show model cache statistics.
file-organizer model cacheExamples:
file-organizer model list
file-organizer model list --type vision
file-organizer model pull qwen2.5:3b-instruct-q4_K_M
file-organizer model cacheInteractive AI copilot for file organisation.
Chat with the file-organisation copilot.
file-organizer copilot chat [MESSAGE] [--dir DIRECTORY]Arguments:
MESSAGE— Single message (optional; omit to start interactive REPL)
Options:
--dir, -d TEXT— Working directory for file operations
Examples:
# Interactive REPL
file-organizer copilot chat
# Single question
file-organizer copilot chat "Help me organize my photos"
# Scoped to a specific directory
file-organizer copilot chat --dir ~/Documents "What duplicates do I have?"Show the status of the AI copilot engine and available models.
file-organizer copilot statusDisplays:
- Number of available Ollama models
- Model names (first 5)
- Copilot readiness status
Examples:
file-organizer copilot status
fo copilot statusRun the file watcher as a background daemon.
file-organizer daemon start [OPTIONS]Common options: --watch-dir PATH, --output-dir PATH
file-organizer daemon stopfile-organizer daemon statusWatch a directory for file events and stream them in real-time.
Usage: file-organizer daemon watch WATCH_DIR [OPTIONS]
Arguments:
WATCH_DIR— Directory to watch for file events
Options:
--poll-interval FLOAT— Seconds between polls (default: 1.0)
Examples:
file-organizer daemon watch ~/Inbox
file-organizer daemon watch ~/Documents --poll-interval 2.0One-shot: organize files in a directory and display a summary.
file-organizer daemon process INPUT_DIR OUTPUT_DIR [OPTIONS]Arguments:
INPUT_DIR— Directory containing files to processOUTPUT_DIR— Destination directory for organized files
Options:
--dry-run— Preview changes without moving files
Examples:
file-organizer daemon process ~/Inbox ~/Organized
# Preview without moving
file-organizer daemon process ~/Downloads ~/Organized --dry-runDisplays a summary table with:
- Total files processed
- Number of files organized
- Skipped and failed counts
- Folder structure created
Examples:
file-organizer daemon start --watch-dir ~/Inbox --output-dir ~/Organized
file-organizer daemon status
file-organizer daemon stopFind and manage duplicate files.
Scan a directory for duplicate files.
file-organizer dedupe scan DIRECTORY [OPTIONS]Generate a duplication report.
file-organizer dedupe report DIRECTORY [OPTIONS]Arguments:
DIRECTORY— Directory to scan
Interactively or automatically resolve duplicates.
file-organizer dedupe resolve DIRECTORY [OPTIONS]Arguments:
DIRECTORY— Directory to scan for duplicates
Examples:
file-organizer dedupe scan ~/Images
file-organizer dedupe report
file-organizer dedupe resolveManage copilot organisation rules and rule sets.
List all rules in a rule set.
file-organizer rules list [--set RULE_SET]List available rule sets.
file-organizer rules setsAdd a new rule to a rule set.
file-organizer rules add RULE_NAME [OPTIONS]Arguments:
NAME— Rule name
Options:
--ext TEXT— File extension filter (e.g..pdf,.docx)--pattern TEXT— Filename glob pattern--action, -a TEXT— Action type:move,rename,tag,categorize,archive,copy,delete(default:move)--dest, -d TEXT— Destination path or pattern--priority, -p INTEGER— Rule priority (higher = runs first; default: 0)--set, -s TEXT— Target rule set (default:default)
Remove a rule from a rule set.
file-organizer rules remove RULE_NAME [--set RULE_SET]Arguments:
NAME— Rule name to remove
Enable or disable a rule.
file-organizer rules toggle RULE_NAME [--set RULE_SET]Arguments:
NAME— Rule name to toggle
Preview what rules would do against a directory (dry-run).
file-organizer rules preview DIRECTORY [OPTIONS]Options:
--set, -s TEXT— Rule set to evaluate (default:default)--recursive/--no-recursive— Recurse into subdirectories (default: true)--max-files INTEGER— Maximum files to scan (default: 500)
Export a rule set to YAML.
file-organizer rules export [--set RULE_SET] [--output FILE]Import a rule set from a YAML file.
file-organizer rules import FILE [--set RULE_SET]Arguments:
FILE— YAML file to import
Examples:
# List rules in the default rule set
file-organizer rules list
# Add a rule to move PDFs to a Docs folder
file-organizer rules add move-pdfs --ext .pdf --action move --dest Docs
# Add a rule with glob pattern, high priority
file-organizer rules add archive-old --pattern "*.2022*" --action archive --priority 10
# Preview rules against a directory
file-organizer rules preview ~/Downloads
# Export/import rule sets
file-organizer rules export --set work --output work-rules.yaml
file-organizer rules import work-rules.yamlGenerate AI-powered file organisation suggestions using pattern analysis.
Generate organisation suggestions for files in a directory.
file-organizer suggest files DIRECTORY [OPTIONS]Options:
--min-confidence FLOAT— Minimum confidence threshold 0–100 (default: 40.0)--max-results INTEGER— Maximum suggestions (default: 50)--json— Output as JSON--dry-run— Preview mode
Apply accepted suggestions.
file-organizer suggest apply DIRECTORY [OPTIONS]Arguments:
DIRECTORY— Directory to organize
Analyze naming patterns in a directory.
file-organizer suggest patterns DIRECTORY [OPTIONS]Examples:
file-organizer suggest files ~/Downloads
file-organizer suggest files ~/Documents --min-confidence 60
file-organizer suggest patterns ~/ProjectsBrowse and manage plugins from the marketplace.
List available plugins.
file-organizer marketplace list [OPTIONS]Options:
--page, -p INTEGER— Page number (default: 1)--per-page INTEGER— Results per page (default: 20)--category, -c TEXT— Filter by category--tag, -t TEXT— Filter by tag (repeatable)
Search the marketplace.
file-organizer marketplace search QUERY [OPTIONS]Show details for a specific plugin.
file-organizer marketplace info PLUGIN_NAMEArguments:
NAME— Plugin name
Install a plugin.
file-organizer marketplace install PLUGIN_NAME [--version VERSION]Arguments:
NAME— Plugin to install
Remove an installed plugin.
file-organizer marketplace uninstall PLUGIN_NAMEArguments:
NAME— Plugin to uninstall
Add or update a review for a plugin.
file-organizer marketplace review PLUGIN_NAME [OPTIONS]Arguments:
PLUGIN_NAME— Name of the plugin to review
Options:
--user TEXT— Reviewer ID (required)--rating INTEGER— Rating from 1 to 5 (required)--title TEXT— Review title (required)--content TEXT— Review text (required)
Examples:
file-organizer marketplace review awesome-plugin \
--user john_doe \
--rating 5 \
--title "Great plugin!" \
--content "This plugin has saved me hours of work!"List installed plugins.
file-organizer marketplace installedCheck for plugin updates.
file-organizer marketplace updatesUpdate a specific plugin.
file-organizer marketplace update PLUGIN_NAMEArguments:
NAME— Plugin to update
Interact with a running File Organizer API server.
Check API server health.
file-organizer api health [--base-url URL] [--json]Authenticate and store access tokens.
file-organizer api login [--base-url URL] [--save-token PATH]Options:
--username— Login username (prompted if not provided)--password— Login password (prompted securely if not provided)
Show current authenticated user.
file-organizer api me [--base-url URL] [--token TOKEN]Invalidate the current session token.
file-organizer api logout [--base-url URL] [--token TOKEN]Options:
--token— Bearer token--refresh-token— Refresh token to revoke
List files via the API.
file-organizer api files PATH [OPTIONS]Arguments:
PATH— Directory to list
Options:
--token— Bearer token
Show system status from the API server.
file-organizer api system-status [--base-url URL]Options:
--token— Bearer token
Show system statistics from the API server.
file-organizer api system-stats [--base-url URL]Options:
--token— Bearer token
Default base URL: http://localhost:8000
Examples:
file-organizer api health
file-organizer api health --base-url http://myserver:8000
file-organizer api login
file-organizer api system-statusManage application updates.
Check for new versions.
file-organizer update checkInstall the latest version.
file-organizer update installRevert to the previous version.
file-organizer update rollbackManage user preference profiles (powered by the intelligence/learning system).
List all available profiles.
file-organizer profile listCreate a new profile.
file-organizer profile create PROFILE_NAME [OPTIONS]Load and activate a profile.
file-organizer profile activate PROFILE_NAMEDelete a profile.
file-organizer profile delete PROFILE_NAMEExport a profile to a file.
file-organizer profile export PROFILE_NAME [--output FILE]Import a profile from a file.
file-organizer profile import FILE [OPTIONS]Arguments:
FILE— Profile file to import
Show the currently active profile and its statistics.
file-organizer profile currentDisplays:
- Active profile name
- Description and version
- Creation and update timestamps
- Statistics (global preferences, directory-specific settings, learned patterns, confidence data)
Merge multiple profiles into one.
file-organizer profile merge PROFILES... [OPTIONS]Arguments:
PROFILES...— Profile names to merge (requires at least 2)
Options:
--output, -o TEXT— Name for merged profile (required)--strategy, -s TEXT— Merge strategy for conflicts:recent,frequent,confident,first,last(default:confident)--show-conflicts— Show conflicts before merging
Examples:
file-organizer profile merge work personal --output merged --strategy confident
# Show conflicts before merging
file-organizer profile merge work personal --output merged --show-conflictsMigrate a profile to a different version.
file-organizer profile migrate PROFILE_NAME [OPTIONS]Arguments:
PROFILE_NAME— Name of the profile to migrate
Options:
--to-version TEXT— Target version (required)--no-backup— Skip backup before migration
Examples:
file-organizer profile migrate work --to-version 2.0
# Migrate without creating backup
file-organizer profile migrate work --to-version 2.0 --no-backupValidate a profile for integrity and compatibility.
file-organizer profile validate PROFILE_NAMEArguments:
PROFILE_NAME— Name of the profile to validate
Examples:
file-organizer profile validate workManage profile templates for common configurations.
List all available templates.
file-organizer profile template listDisplays all available templates with their descriptions.
Preview a template before applying it.
file-organizer profile template preview TEMPLATE_NAMEArguments:
TEMPLATE_NAME— Name of the template to preview
Displays:
- Template description
- Preferences summary (naming patterns, folder mappings, category overrides)
- Learned patterns and confidence levels
Examples:
file-organizer profile template preview default
file-organizer profile template preview minimalCreate a profile from a template.
file-organizer profile template apply TEMPLATE_NAME PROFILE_NAME [OPTIONS]Arguments:
TEMPLATE_NAME— Name of the template to applyPROFILE_NAME— Name for the new profile
Options:
--activate, -a— Activate the profile immediately after creation
Examples:
file-organizer profile template apply default myprofile
# Apply template and activate it
file-organizer profile template apply minimal myprofile --activateGeneral Profile Examples:
file-organizer profile list
file-organizer profile create work --description "Work files config"
file-organizer profile activate workNote: The
profilecommand requires the intelligence/learning optional dependencies (pip install -e ".[all]"). It degrades gracefully if not installed.
AI-powered tag suggestions and management.
Suggest tags for files in a directory.
file-organizer autotag suggest DIRECTORY [OPTIONS]Options:
--top-n, -n INTEGER— Max suggestions per file (default: 10)--min-confidence FLOAT— Minimum confidence % (default: 40.0)--json— Output as JSON
Apply tags to a file and record for learning.
file-organizer autotag apply FILE_PATH TAG...Arguments:
FILE_PATH— File to tagTAGS— One or more tags to apply
Show the most popular tags.
file-organizer autotag popular [--limit N]Options:
--limit, -n INTEGER— Number of tags to show (default: 20)
Show recently used tags.
file-organizer autotag recent [OPTIONS]Options:
--days INTEGER— Days to look back (default: 30)--limit, -n INTEGER— Number of tags to show (default: 20)
Batch tag suggestion for a directory.
file-organizer autotag batch DIRECTORY [OPTIONS]Options:
--pattern TEXT— File pattern (default:*)--recursive / --no-recursive— Recurse into subdirectories (default: true)--json— Output as JSON
Examples:
file-organizer autotag suggest ~/Documents
file-organizer autotag apply ~/Documents/report.pdf finance quarterly
file-organizer autotag popular --limit 10
file-organizer autotag recent --days 7
file-organizer autotag batch ~/Documents --pattern "*.pdf" --jsonUse fo as a short alias for file-organizer:
fo serve
fo organize ~/Downloads ~/Organized
fo search "*.pdf" ~/Documents
fo analyze ~/Documents/report.pdf
fo tui
fo copilot chat
fo dedupe scan ~/Pictures
fo autotag suggest ~/Documentsfile-organizer --help
file-organizer COMMAND --help
file-organizer COMMAND SUBCOMMAND --helpFor example:
file-organizer rules --help
file-organizer rules add --help
file-organizer suggest --help