2.3 KiB
2.3 KiB
Documentation Status
- Synced with refactor baseline on 2026-02-16.
VLM Command Recipes
Baseline
Run from repository root unless user specifies otherwise.
vlm --help
vlm config show
vlm config validate
If vlm is not on PATH, switch to:
uv run vlm --help
uv run vlm config show
uv run vlm config validate
End-to-End Pipeline
vlm scan --output inventory.csv
vlm parse --input inventory.csv --output identities.json --inventory inventory.csv
vlm enrich
vlm analyze --input identities.json --output analysis.json --inventory inventory.csv
vlm plan --input identities.json --output plan.json --analysis analysis.json
vlm review-plan --input plan.json --output plan_manual_review.csv
vlm execute --plan plan.json
vlm execute --plan plan.json --confirm
Artifact Expectations
inventory.csv: discovered video files with filesystem and optional ffprobe metadata.identities.json: parsed identities for movie/series/anime/other, optionally with embedded quality metadata.analysis.json: completeness gaps and duplicate groups with quality comparison context.plan.json: planned operations (move,rename,quarantine,no-op) and summary data.plan_manual_review.csv: high-risk operations requiring human confirmation before--confirm.
Focused Workflows
# Parse only, with metadata embedding
vlm parse --inventory inventory.csv
# Analyze only
vlm analyze --input identities.json --output analysis.json --inventory inventory.csv
# Plan from analysis-assisted duplicate decisions
vlm plan --input identities.json --analysis analysis.json --output plan.json
# Roll back latest confirmed execution
vlm rollback
Frequent Failure Triage
- Missing config:
Run
vlm config init, then setlibrary_rootin~/.vlm/config.yaml. - Invalid config values:
Run
vlm config validateand fix reported keys. - Missing input artifact:
Run the prerequisite stage (
scanbeforeparse,parsebeforeanalyze,analyzebefore analysis-drivenplan). - Unexpected duplicate decisions:
Check
plan.duplicate_keepin config and rerunvlm plan --analysis analysis.json. - Unsafe or undesired execution results:
Run
vlm rollbackand inspect plan before re-runningexecute --confirm. vlmcommand not found: Useuv run vlm ...fallback for the same subcommands.