Skip to content

README.md

Latest commit

 

History

History
63 lines (48 loc) · 2.03 KB

README.md

File metadata and controls

63 lines (48 loc) · 2.03 KB

GitHub Backup Browser MVP Plan

This directory contains the implementation plan for ghbb, a Python/SQLite browser and search tool for backups produced by python-github-backup.

Important local paths

  • Project root: C:\CodeBlocks\github-backup-browser
  • Test backup root: C:\CodeBlocks\ggml-org-backup\backup
  • Test backup root from Git Bash/WSL-style shells: /c/CodeBlocks/ggml-org-backup/backup
  • Backup script that produced the test data: C:\CodeBlocks\ggml-org-backup\backup.py
  • Backup tool source, if needed for format details: C:\CodeBlocks\python-github-backup

Core decisions

  • Use Python managed by uv.
  • Use SQLite with FTS5 for search.
  • Default DB path is GHBB_DB if set, otherwise ./ghbb.db in the current working directory.
  • Do not expose a --db option in the MVP.
  • Do not expose an --org option in the MVP.
  • Derive owner/repo from URLs inside the JSON files.
  • Do not store raw JSON in SQLite.
  • Always import attachment metadata.
  • Never import attachment file contents/BLOBs into SQLite.
  • It is acceptable for MVP import to rebuild the database contents from scratch.

Planned CLI shape

cd C:\CodeBlocks\github-backup-browser
uv run ghbb import C:\CodeBlocks\ggml-org-backup\backup
uv run ghbb stats
uv run ghbb search "KV cache"
uv run ghbb show llama.cpp issue 1
uv run ghbb serve

With DB override:

set GHBB_DB=C:\tmp\ggml-ghbb.db
uv run ghbb import C:\CodeBlocks\ggml-org-backup\backup

PowerShell:

$env:GHBB_DB = "C:\tmp\ggml-ghbb.db"
uv run ghbb search "cuda graph"

Git Bash:

GHBB_DB=/c/tmp/ggml-ghbb.db uv run ghbb search "cuda graph"

Document map