Status: Active, alpha-quality. Targets incremental, atomic releases with clear scope and guardrails.
Guiding Principles
- Environment-first configuration; no secrets in Git.
- Atomic Conventional Commits; CI-guarded quality gates.
- Docs-as-code with ADRs for significant decisions.
- Small, safe increments; prefer staging and dry-run modes.
Milestones
Alpha (current)
- CLI save/retrieve with env-driven config and
${VAR:-default}interpolation. - Local storage (Markdown chunks + JSON index). Newest-first retrieval.
- Tests (pytest ≥85% coverage), ruff lint/format, Makefile targets.
- Basic retention (max chunks/age). Read-only and dry-run safety.
- Write lock to avoid concurrent writes.
- Docs: README, LOCAL_VALIDATION, MkDocs site, ADRs, Governance, Security.
- CI: tests (3.10–3.13), lint, Conventional Commits (commits + PR titles).
Beta
- Search and indexing: add lightweight full-text search (e.g., Whoosh or ripgrep integration) with results ranked by recency+match.
- Metadata enhancements: tags, actors (user/assistant/system), source attribution.
- Robust file locking across platforms and network filesystems; error handling with retries.
- Backup/export tooling: archive by date/project; integrity checks.
- Observability: structured logs, basic metrics (saves, retrievals, prunes).
- Packaging: publish to PyPI; signed releases; SBOM generation.
- Security: pip-audit action; dependency update automation.
- VS Code polish: commands palette and keybindings; diagnostics on failure.
GA
- API stability: versioned CLI and Python API; deprecation policy.
- Performance: large-index benchmarks; batch operations.
- Pluggable storage backends: local FS + S3/GCS + SQLite index option.
- Kubernetes operational docs: Helm chart with External Secrets & PVC; runbook.
- Supply chain: signed artifacts (Sigstore), SLSA provenance.
- Governance maturity: CODEOWNERS, release rotation, support window.
Out of Scope (for now)
- Multi-tenant server/service backend.
- End-to-end encryption of history at rest (future consideration).
- LLM-specific tooling beyond generic chat capture/retrieval.