generated from coulomb/repo-seed
chore(docs+tests): complete T05 + T06 for CYA-WP-0002. All 6 tasks done. README Memory section, AGENTS update, full test coverage for real memory + safety. Workplan retired.
This commit is contained in:
30
README.md
30
README.md
@@ -53,13 +53,39 @@ clear preview + confirmation prompt. Nothing executes without your explicit yes.
|
||||
|
||||
See the risk classifier tests and workplan T03 for the exact rules and invariants.
|
||||
|
||||
## Memory (T02 + T03 + T04)
|
||||
|
||||
`cya` has real, user-controlled memory for preferences and workflow patterns.
|
||||
|
||||
```bash
|
||||
# Remember something for this directory / project
|
||||
cya "remember that I prefer to see git status --short --branch by default"
|
||||
|
||||
# Later, in the same directory, cya will recall it without you restating
|
||||
cya "what is my preferred git view?"
|
||||
|
||||
# You can always inspect or clear what is stored
|
||||
cya --explain-context "..." # shows memory provenance
|
||||
# The backing files live in ~/.config/cya/memory/ (plain JSON, fully user-editable)
|
||||
```
|
||||
|
||||
Memory signals also feed the safety layer: a standing "never auto-run" preference will still force mandatory confirmation even for commands the rules might otherwise treat more leniently.
|
||||
|
||||
All memory usage is visible and explainable. Nothing is hidden or opaque.
|
||||
|
||||
See:
|
||||
- `src/cya/memory/__init__.py` (the explicit seam)
|
||||
- `workplans/CYA-WP-0002-memory-integration-roadmap.md`
|
||||
- `MemoryVision.md` for the longer-term direction (profile-driven phase-memory)
|
||||
|
||||
## Architecture & boundaries (important)
|
||||
|
||||
- `can-you-assist` (this repo): CLI, context collection, safety, orchestration.
|
||||
- `llm-connect`: Provider access, config, token counting, structured responses.
|
||||
All interaction goes through `cya/llm/adapter.py` (`LLMAdapter` Protocol).
|
||||
- `phase-memory`: Durable, user-controlled memory. This slice has only
|
||||
strictly minimal explicit no-op ports (see `cya/memory/__init__.py`).
|
||||
- `phase-memory`: Durable, user-controlled memory. Real (persisting) implementation
|
||||
lives behind the explicit ports in `cya/memory/__init__.py` (T02). Signals also flow
|
||||
into the rule-based risk layer (T04).
|
||||
|
||||
See `workplans/CYA-WP-0001-console-native-mvp.md` for the full task breakdown,
|
||||
decisions, and integration guide.
|
||||
|
||||
Reference in New Issue
Block a user