6f0df5a774
Stop tracking personal workflow artifacts at repo root, add CI and MIT license, align README and agent skills with artifacts/ defaults, and enable Ruff in dev/CI so releases are verifiable without local-only runs. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
32 lines
1.7 KiB
Markdown
32 lines
1.7 KiB
Markdown
# Documentation Status
|
|
- Updated to current CLI options on 2026-06-01. Default artifact paths are under `artifacts/`.
|
|
|
|
# VLM CLI Reference
|
|
|
|
## Configuration
|
|
- `vlm config init`: Create default config.
|
|
- `vlm config show`: Display current settings.
|
|
- `vlm config validate`: Check config for errors.
|
|
|
|
## Core Commands
|
|
- `vlm scan [--output PATH]`: Discover video files.
|
|
- `vlm parse [--input CSV] [--output JSON] [--inventory CSV]`: Parse filenames.
|
|
- `vlm enrich [--input JSON] [--output JSON] [--refresh-all]`: Fetch TMDB metadata.
|
|
- `vlm analyze [--input JSON] [--output JSON]`: Find gaps and duplicates.
|
|
- `vlm plan [--input JSON] [--analysis JSON] [--output JSON]`: Generate operations.
|
|
- `vlm review-plan [--input JSON] [--output CSV] [--tui]`: Export manual review CSV (optional Textual UI).
|
|
- `vlm apply-review [--plan JSON] [--csv PATH]`: Sync edited review CSV into plan.
|
|
- `vlm execute [--plan JSON] [--confirm] [--yes] [--verbose-ops] [--safe-mode] [--preserve-directories]`: Move/Rename/Quarantine operations with safety guards.
|
|
- `vlm rollback [--log PATH]`: Undo operations.
|
|
|
|
## Management & Reporting
|
|
- `vlm quarantine list|add|restore`: Manage the `.quarantine` directory.
|
|
- `vlm report inventory|completeness|duplicates|summary`: Generate human-readable reports.
|
|
- `vlm state show|set|query|clear`: Track manual review status for files.
|
|
|
|
## Important Config Options (`~/.vlm/config.yaml`)
|
|
- `library_root`: Path to the video collection.
|
|
- `templates`: Naming patterns for movies and series.
|
|
- `plan.duplicate_keep`: Strategy for duplicates (`by_quality`, `by_reputation`, `by_reputation_quality_time`, `first_seen`, `manual`).
|
|
- `enrichment.api_keys`: TMDB and OpenAI keys.
|