📚 User Guide¶
Learn how to use SpecMem effectively in your projects.
Overview¶
SpecMem provides a comprehensive toolkit for managing specifications and context for AI coding agents. This guide covers all major features.
For an end-to-end view of SpecMem as an external memory layer for coding agents, see Building a Memory Layer for Coding Agents.
Core Features¶
Workflow¶
graph TD
A[Write Specs] --> B[specmem scan]
B --> C[specmem build]
C --> D[Agent Context Ready]
D --> E{Code Changes?}
E -->|Yes| F[specmem impact]
F --> G[Selective Tests]
E -->|No| H[specmem query]
H --> I[Get Context]
Best Practices¶
Keep Specs Updated
Run specmem scan after updating specifications to keep the index fresh.
Use Impact Analysis
Before committing, run specmem impact to understand the scope of your changes.
Validate Regularly
Run specmem validate in CI to catch spec issues early.
Leverage the Web UI
Use specmem serve for visual exploration of your spec graph.