Quickstart
Get Hobbyboard running with Docker in minutes.
docker run --rm -p 9625:9625 \
-v /path/to/raw_images:/app/raw_images \
-v /path/to/dist:/app/dist \
ghcr.io/aravindhsampath/hobbyboard:latest
Or run locally:
hobbyboard init
hobbyboard build
hobbyboard serve
Install
Hobbyboard ships as a single Rust binary.
- Linux: download the binary from GitHub Releases.
- macOS: download the binary or use Docker.
- Windows: use the CI artifact or build from source.
Configure
Config lives in hobbyboard.toml. Key paths:
raw_media_dir: source folder for media.dist_dir: where thumbnails, DB, metadata live.prompt_analysis: AI prompt used for captions/tags.
Core Workflow
- init: create DB + vector collection.
- build: scan, process, analyze, embed, index.
- serve: launch web UI and API.
Operations
Diagnostics and housekeeping:
- check: verify DB + file consistency.
- export: generate a shareable archive.
- build --refresh: reprocess metadata safely.
Contributing
We keep the project single‑binary and local‑first. If you contribute:
- Prefer small, focused PRs.
- Keep tests up to date.
- Document new flags or config keys.