mental

Documentation

Overview

Package mental implements auto-generated project mental models. A mental model is a high-level summary of the project that evolves as memories grow. Based on Hindsight's mental models concept.

Example mental model:

"This project is a TypeScript API using jose for JWT auth (RS256),
 NATS for event bus, PostgreSQL with pgbouncer. Key conventions:
 named exports only, pnpm test before commit. Active work: rate limiting."

Index

• type Model
  • func Generate(ctx context.Context, store storage.Storage, project string) (*Model, error)
  • func (m *Model) Format() string

Types

type Model

type Model struct {
	Project      string   `json:"project"`
	Summary      string   `json:"summary"`
	Stack        []string `json:"stack"`
	Conventions  []string `json:"conventions"`
	ActiveTasks  []string `json:"active_tasks"`
	KnownBugs    []string `json:"known_bugs"`
	KeyDecisions []string `json:"key_decisions"`
}

Model is an auto-generated project summary.

func Generate

func Generate(ctx context.Context, store storage.Storage, project string) (*Model, error)

Generate creates a mental model from the current memory graph. No LLM needed — built from high-confidence nodes.

func (*Model) Format

func (m *Model) Format() string

Format returns the mental model as markdown for agent injection.