Skip to content

process

fialr process <target> [options]

Run the full processing pipeline in sequence: scan, classify, enrich, rename. Dry-run by default. To apply changes, pass both --execute and --reviewed.


ArgumentDescription
targetDirectory to process (required)
OptionDescription
--executeApply changes (not just dry-run)
--reviewedConfirm that execution is approved (required with --execute)
--no-enrichSkip the enrichment phase
--no-renameSkip the rename phase
--output-dir PATHOutput directory for pipeline artifacts
--sensitivity-rules PATHPath to sensitivity.yaml (default: config/sensitivity.yaml)
--schema PATHPath to schema.yaml (default: config/schema.yaml)

process runs four phases in sequence:

  1. Scan — inventory the target directory and compute hashes
  2. Classify — assign sensitivity tiers and categories
  3. Enrich — extract text and run AI inference to generate metadata
  4. Rename — apply naming templates based on enrichment results

Each phase can have errors without blocking subsequent phases. A file that fails enrichment still proceeds to the rename phase using whatever metadata is available.

Without --execute, process runs all phases in dry-run mode. No files are modified. The output shows what would happen at each stage. A YAML plan is written to the output directory for review before execution.

With --execute --reviewed, the pipeline applies enrichment metadata and renames files. Requires a license for --execute.

Use --no-enrich to skip AI inference (scan, classify, rename only). Use --no-rename to skip renaming (scan, classify, enrich only).


Dry-run:

process ~/Documents
SCAN 847 files (2.3s)
CLASSIFY 847 files (0.1s)
ENRICH 623 files (45.2s)
RENAME 623 files (0.4s)
────────────────────────────────────────────────────────
files 847
enriched 623
renamed 623
review 89
errors 0
total 48.0s

Terminal window
# Dry-run the full pipeline
fialr process ~/Documents
# Execute the full pipeline
fialr process ~/Documents --execute --reviewed
# Pipeline without renaming
fialr process ~/Documents --no-rename
# Pipeline without enrichment
fialr process ~/Documents --no-enrich
# Specify output directory
fialr process ~/Documents --output-dir ./results

  • scan — the scan and classify phase
  • enrich — the enrichment phase
  • rename — the rename phase
  • organize — move enriched files into schema directories
  • cleanup — dedup and validate