Skip to content

README.md

Latest commit

 

History

History
37 lines (28 loc) · 2.16 KB

README.md

File metadata and controls

37 lines (28 loc) · 2.16 KB
Raw

@memo/core Overview

Core provides the central capabilities of Memo Code CLI: the ReAct loop, session state management, default dependency wiring (LLM/tools/prompt/history), config loading, and shared types/utilities. The design goal is "thick Core, thin UI": UI handles interaction and callbacks, while Core owns behavior.

Directory Layout

  • config/
    • config.ts: Reads ~/.memo/config.toml (providers, sessions path), handles provider selection, session path building, and config writes.
  • runtime/
    • prompt.ts/xml: System prompt loading.
    • history.ts: JSONL history sink and event construction.
    • defaults.ts: Default dependency completion (toolset, LLM, prompt, history sink, tokenizer).
    • session.ts: Session/Turn runtime, executes ReAct loop, writes events, tracks token usage.
  • types.ts: Shared types (AgentDeps, Session/Turn, TokenUsage, HistoryEvent, etc.).
  • utils/
    • Utility functions (assistant output parsing, message wrappers).
    • tokenizer.ts: lightweight token estimation helpers (fallback with AI SDK usage).
  • index.ts: Package entry, exports core modules and types.

Key Flows

  • createAgentSession(deps, options): Creates a Session, fills default dependencies, loads prompt, and returns an object with runTurn.
  • withDefaultDeps: Injects default toolset, AI SDK Gateway client, prompt, history sink (writes to ~/.memo/sessions/YY/MM/DD/<uuid>.jsonl), and tokenizer based on config and overrides.
  • Session history: JSONL events (session_start/turn_start/assistant/action/observation/final/turn_end/session_end) with metadata like provider, model, tokenizer, and token usage.
  • Config: ~/.memo/config.toml (overridable via MEMO_HOME). If missing, UI setup flow is triggered.

Usage Example

import { createAgentSession } from '@memo/core'

const session = await createAgentSession({ onAssistantStep: console.log }, { mode: 'interactive' })
const turn = await session.runTurn('Hello')
await session.close()

If you provide custom tool/LLM/prompt/sink dependencies, override the related fields in deps/options. Defaults select the current provider and write sessions in the user directory.