Skip to content

Command Reference

Jacob Chirayath edited this page Jun 11, 2026 · 3 revisions

Command Reference

All commands read paths from config.toml (resolved relative to that file).

mediahound init <dir>

Scaffold a new site folder (template + config.toml). --force overwrites template files.

mediahound build

Process new cover photos and (re)generate the catalog. Incremental — only unseen images (tracked by sha256) are processed.

Flag Meaning
--online Allow metadata / where-to-watch lookups. Default is offline (regenerate from existing data).
--refresh-streaming Re-check where-to-watch for every title (implies --online).
--force Reprocess every image, not just new ones.
--reidentify <hash> Reprocess a single image by its sha256.
--limit <N> Process at most N new images this run.
--mock Demo with bundled sample data (no providers/keys).

mediahound app [dir]

The easy button. Sets up a library (default ./MediaHound-Library) if needed, then opens the editor in your browser with the write API on — no other commands to remember.

Flag Default Meaning
--phone off Open to your Wi-Fi and print a QR code so you can add photos from your phone. Uploads are token-protected; localhost-only actions (API keys, publish) stay disabled. Trusted networks only.
--port <N> 8765 Port.
--host <H> 127.0.0.1 Bind address.
--no-open off Don't auto-open a browser.

mediahound gui [dir]

Open the editor in a native desktop window (the bundled .app / .exe runs this). Library defaults to ~/MediaHound Library. Needs the desktop extra (pip install "mediahound[desktop]"); falls back to the browser without it.

mediahound serve

Preview the generated site locally over http (avoids file:// fetch limits).

Flag Default Meaning
--admin off Enable the localhost write API — admin-portal edits (and photo upload, CSV import, API keys, publish) save straight to data/ and survive every rebuild. See Editing and Persisting Changes.
--port <N> 8765 Port.
--host <H> 127.0.0.1 Bind address (keep admin on localhost).
--no-open off Don't auto-open a browser.

Security: the write API is a local authoring tool. It binds to 127.0.0.1 and refuses cross-origin writes; API-key and publish actions are localhost-only (refused over --phone). Never expose it publicly; public hosting serves the plain static files.

Admin-console actions (under app / serve --admin / gui)

  • ➕ Add photos — drag-and-drop covers (movies/music) straight into the catalog.
  • ⬆ Import list — bulk-add titles from a CSV.
  • ⚙ Settings → API keys — store TMDB / OMDb / Anthropic keys in the OS keychain (write-only).
  • 🌐 Publish — deploy the catalog to Netlify (paste a token once) and get a shareable link.
  • ↻ Rebuild — re-bake the catalog from your saved edits.

mediahound import <file.csv>

Bulk-add movies & music from a CSV (no photos needed). --online enriches each row.

mediahound export -o catalog.csv

Write the whole catalog to a CSV (backup / migration).

Clone this wiki locally