Skip to content

memory.md

Latest commit

 

History

History
121 lines (84 loc) · 3.36 KB

memory.md

File metadata and controls

121 lines (84 loc) · 3.36 KB
Raw

Memory

OpenSquilla memory helps the agent recall durable context without replaying every old conversation. Use it for stable preferences, reusable project facts, previous decisions, and notes that should survive across sessions.

Memory is separate from skills. Skills teach the agent how to do a task; memory stores useful facts and context the agent may need later.

What to Store

Good memory entries are stable and reusable:

  • user preferences;
  • project conventions;
  • recurring output formats;
  • names of important repositories, directories, or services;
  • decisions the user wants reused;
  • brief notes from completed tasks.

Avoid memory for:

  • API keys or secrets;
  • raw private data that does not need long-term recall;
  • one-off instructions for the current turn;
  • noisy dumps that would pollute future retrieval;
  • exact transcripts that should instead be exported as session records.

Common Commands

Inspect memory health:

opensquilla memory status
opensquilla memory status --deep

Index and list memory sources:

opensquilla memory index
opensquilla memory list

Search and inspect memory:

opensquilla memory search "release note format"
opensquilla memory show <path>

Search previous sessions as well as memory:

opensquilla memory search "deployment decision" --source all

Configured Sources and Projects

Profile, memory, and note files come from the configured Agent sources. These sources can differ from the task workspace and from each other. Opening a project does not create project-specific memory or relocate existing sources. Profile settings, memory tools, and runtime loading resolve those configured sources consistently; search indexes remain derived data.

When authorized, memory_save writes durable facts to logical MEMORY.md or memory/ paths in those sources. It does not edit USER.md, IDENTITY.md, or SOUL.md. Updating these profile files requires an existing file tool with access to the known configured path. If access is unavailable, the Agent should explain the limitation rather than create an ineffective project-local copy.

Natural Chat Usage

Ask naturally when something should be remembered:

Remember that I prefer concise release notes with a risk section.

Later, refer to the preference:

Use my usual release-note format for this changelog.

When memory seems stale, ask the agent to search explicitly:

Search memory for my release-note preferences before drafting this.

Session-Derived Memory

Use session export when exact old wording matters:

opensquilla sessions export <session-key>

Memory is for useful recall. Session export is for exact records.

Index Maintenance

Refresh the index after editing memory files or changing memory configuration:

opensquilla memory index --force

Best Practices

  • Keep entries short and sourceable.
  • Prefer "Remember X for project Y" over vague "remember this."
  • Search memory before assuming the agent forgot.
  • Remove or revise stale preferences instead of adding contradictory ones.
  • Keep secrets out of memory.
  • Use artifacts or files for large reference material.

Docs index · Product guide · Improve this page · Report a docs issue