Documentation
Docs
Memo Docs
Documentation sourced directly from /docs/user. Covers setup, usage, configuration, and troubleshooting.
Recommended reading path
Step 1
Getting Started
Memo Code is a lightweight coding agent that runs in your terminal and assists coding workflows through natural language.
Step 2
CLI / TUI Usage
Memo has two primary usage modes: interactive TUI (default) and one shot mode ( once).
Step 3
Configuration (Provider / Config)
Memo uses config.toml to manage providers, models, MCP servers, and other runtime settings.
This documentation set is intended for end users (different from implementation/proposal docs under docs/), split by module so you can read only what you need.
Memo Code is a lightweight coding agent that runs in your terminal and helps you complete coding tasks with natural-language commands.
Recommended Reading Order
Documentation Index (By Module)
- Getting Started
- CLI / TUI Usage
- Configuration (Provider / Config)
- Tools (Built-in Tool Overview)
- Tool Approval and Safety
- MCP Extensions (External Tools/Services)
- Sessions and Logs (History / Sessions)
- Long-term Memory
- Troubleshooting
Other References
- Project intro and installation:
README.md - Detailed tool parameter docs:
docs/tool/* - Core implementation and architecture:
docs/core.md
Basics
Capabilities
Capabilities
Configuration (Provider / Config)
Memo uses config.toml to manage providers, models, MCP servers, and other runtime settings.
Capabilities
Tools (Built-in Tool Overview)
Memo has a built in toolset and also supports external tools via MCP. In most cases, you do not need to call tools manually. Just describe your goal clearly and explicitly specify which files should be read or changed.
Capabilities
Tool Approval and Safety
Memo enables tool approval by default. When the model tries potentially risky actions (file writes, command execution, etc.), Memo asks for permission first.
Capabilities
MCP Extensions (External Tools/Services)
MCP (Model Context Protocol) lets Memo connect external tool servers and expose additional capabilities to the model (for example internal knowledge base, ticket systems, browser automation).
Operations
Operations
Sessions and Logs (History / Sessions)
Memo writes session activity as a local JSONL event stream for context resume, debugging, and review.
Operations
Long-term Memory
Memo can store user preferences/profile info in a local memory file and inject it into future system prompts for more consistent behavior.
Operations
Troubleshooting
Symptom: startup/runtime reports Missing env var ....