memory

Documentation

Overview

Package memory implements persistent memory storage for Hermes mode. Memory is stored as a human-readable Markdown file (memory.md).

Index

• type MemoryTool
  • func NewMemoryTool(store *Store) *MemoryTool
  • func (t *MemoryTool) Description() string
  • func (t *MemoryTool) Execute(ctx context.Context, params map[string]any) (tools.ToolResult, error)
  • func (t *MemoryTool) Name() string
  • func (t *MemoryTool) Parameters() json.RawMessage
  • func (t *MemoryTool) PromptGuidelines() []string
  • func (t *MemoryTool) PromptSnippet() string
• type Store
  • func NewStore(explicitPath, workDir string) *Store
  • func (s *Store) Add(section, entry string) error
  • func (s *Store) Delete(section, entry string) error
  • func (s *Store) Read() (content string, path string, source string, err error)
  • func (s *Store) ReadSection(section string) (string, error)
  • func (s *Store) Resolve() (path string, source string, err error)
  • func (s *Store) Update(section, oldText, newText string) error
  • func (s *Store) WriteAll(content string) error

Types

type MemoryTool

type MemoryTool struct {
	// contains filtered or unexported fields
}

MemoryTool provides persistent memory read/write via memory.md.

func NewMemoryTool

func NewMemoryTool(store *Store) *MemoryTool

NewMemoryTool creates a new memory tool.

func (*MemoryTool) Description

func (t *MemoryTool) Description() string

func (*MemoryTool) Execute

func (t *MemoryTool) Execute(ctx context.Context, params map[string]any) (tools.ToolResult, error)

func (*MemoryTool) Name

func (t *MemoryTool) Name() string

func (*MemoryTool) Parameters

func (t *MemoryTool) Parameters() json.RawMessage

func (*MemoryTool) PromptGuidelines

func (t *MemoryTool) PromptGuidelines() []string

func (*MemoryTool) PromptSnippet

func (t *MemoryTool) PromptSnippet() string

type Store

type Store struct {
	// contains filtered or unexported fields
}

Store manages reading and writing of memory.md files.

func NewStore

func NewStore(explicitPath, workDir string) *Store

NewStore creates a memory store. If explicitPath is non-empty, it overrides the default discovery logic. workDir is used as fallback directory for creating new memory files.

func (*Store) Add

func (s *Store) Add(section, entry string) error

Add appends a line to a specific section.

func (*Store) Delete

func (s *Store) Delete(section, entry string) error

Delete removes a line from a section.

func (*Store) Read

func (s *Store) Read() (content string, path string, source string, err error)

Read returns the full content of memory.md.

func (*Store) ReadSection

func (s *Store) ReadSection(section string) (string, error)

ReadSection returns the content of a specific ## section.

func (*Store) Resolve

func (s *Store) Resolve() (path string, source string, err error)

Resolve finds the memory.md file to use. Priority: explicit path → .mothx/memory.md → <GLOBAL_DIR>/memory.md Returns (path, source, error). source is "explicit", "project", "global", or "".

func (*Store) Update

func (s *Store) Update(section, oldText, newText string) error

Update replaces old text with new text in a section.

func (*Store) WriteAll

func (s *Store) WriteAll(content string) error

WriteAll overwrites the entire memory.md content.