What problem does it solve?
Spec-index prevents repeated investigation and lost institutional knowledge by turning one-off discoveries—decisions, setup gotchas, root causes, fixes, and patterns—into durable, searchable project memory that agents and developers can retrieve during planning, correction, and onboarding.
Core Features & Use Cases
- Deterministic local Markdown indexing and retrieval with a canonical entry template for consistent capture.
- A Python helper (scripts/index.py) offering add, search, audit, and rebuild commands to keep the knowledge base synchronized and auditable.
- Repository-aware behavior: obeys a repository root SPEC.md when present and falls back to built-in defaults (docs/knowledge-base, references/template.md).
- Use cases: surface prior fixes when debugging failing CI, capture validated root causes after a triage session, onboard new contributors with consolidated setup rules, or audit and clean weak or duplicate entries.
Quick Start
Use spec-index to search for prior entries about authentication 401 errors in the API component and return concise takeaways and recommended next steps.