Docs & quickstart

Quickstart

mkdir -p demo-data && echo hello > demo-data/notes.txt
cp .env.example .env   # defaults work for the demo
BACKKEEP_SOURCE_PATH=./demo-data BACKKEEP_BACKUP_ROOT=./backups \
  python3 -m backkeep.cli backup
BACKKEEP_BACKUP_ROOT=./backups python3 -m backkeep.cli drill
# → Restore drill PASS: N files verified from snapshot ...

API reference

• CLI-first (stdlib only). Commands: backup, drill, schedule, list, auth, health.
• `backup` — one snapshot + manifest + retention prune. `drill` — hash-verified restore test.
• `schedule` — run forever on BACKKEEP_SCHEDULE_MINUTES. Designed for systemd.
• `auth google|m365` — prints the OAuth setup instructions (Google adapter built, live verification pending Google OAuth app verification; M365 adapter in build-out).
• Full reference: OPENAPI.md in the repo.

The complete reference (every endpoint/command with method, path, auth, and example request/response) ships as OPENAPI.md in the product repo.

Support

Questions? Contact us — a human reads every message.