Canon Commands

Common Options

Most commands that operate on sources share these options:

Path scope — Limit a command to a specific directory by passing a path:

canon ls /path/to/photos
canon facts /path/to/photos
canon coverage /path/to/photos

Filters — Select sources using --where with boolean expressions:

canon ls --where 'source.ext=jpg'
canon facts --where 'source.size > 1000000'
canon cluster generate --where 'geo.country=Netherlands' --dest /archive

Multiple --where flags are combined with AND. See Filters for the full syntax.

Command Reference

• Managing Roots: Add and manage storage locations
  • scan: Scan existing or new roots
  • roots: List, suspend, or remove roots
• Enriching: Import metadata from external tools
  • worklist: Output sources for external processing
  • import-facts: Import processor output
  • Writing Processors: Build custom extractors
• Querying: Explore your indexed files
  • ls: List sources matching filters
  • facts: Discover available metadata
  • compare: Compare directories by content
• Managing Sources: Control which sources are processed
  • exclude: Mark sources to skip during archiving
• Archiving: Organize files into your canonical archive
  • coverage: Check archive progress
  • cluster: Generate a manifest for archiving
  • apply: Execute the manifest to copy/move files