Help us improve
Share bugs, ideas, or general feedback.
From obsidi-backup
Get started with obsidi-backup — what it is, how to set it up, and how to use it
npx claudepluginhub cameronsjo/obsidi-backup --plugin obsidi-backupHow this skill is triggered — by the user, by Claude, or both
Slash command
/obsidi-backup:onboardThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Guide the user through getting started with **obsidi-backup**.
Creates p5.js generative art with seeded randomness, noise fields, and interactive parameter exploration. Use for algorithmic art, flow fields, or particle systems.
Share bugs, ideas, or general feedback.
Guide the user through getting started with obsidi-backup.
obsidi-backup is a lightweight sidecar container that automatically backs up Obsidian vaults with git versioning and encrypted cloud storage via restic. It watches for file changes, auto-commits with optional AI-generated messages (Claude Haiku), and pushes deduplicated backups to Azure, S3, B2, or any restic backend.
Check that the user has the following installed/configured:
RESTIC_REPOSITORY and RESTIC_PASSWORD environment variables setWalk the user through initial setup:
uv pip install -e ".[dev]"
export RESTIC_REPOSITORY="azure:container:/path" # or s3, b2, sftp, local
export RESTIC_PASSWORD="your-encryption-password"
export VAULT_PATH="/path/to/your/obsidian/vault"
export ANTHROPIC_API_KEY="sk-ant-..."
docker build -t vault-backup .
Guide the user through their first interaction with the product:
VAULT_PATH=/path/to/vault RESTIC_REPOSITORY=... RESTIC_PASSWORD=... python -m vault_backup
http://localhost:8080/health to verify status.For Docker, use the Quick Start compose snippet from README.md and run docker exec vault-backup restic init to initialize the repository on first run.
Point the user to the most important files for understanding the project:
src/vault_backup/__main__.py - Entry point: structured logging, Sentry init, signal handlingsrc/vault_backup/watcher.py - File system monitoring with watchdog and path-segment ignore patternssrc/vault_backup/backup.py - Git commit, restic backup, LLM commit message generationsrc/vault_backup/config.py - Frozen dataclass configuration loaded from environment variablessrc/vault_backup/health.py - HTTP /health and /ready endpointssrc/vault_backup/ui.py - htmx-powered web UI at /ui for browsing snapshots and restoring filesDockerfile - Alpine-based multi-arch container imagepyproject.toml - Project metadata, dependencies, ruff/pytest configuv run --extra dev pytest -v
uv run --extra dev pytest --cov=vault_backup --cov-report=term-missing
uv run --extra dev ruff check src/
uv run --extra dev ruff format src/
docker build -t vault-backup .
bd ready
bd list --all