Documentation: Getting Started

Memo Code is a lightweight coding agent that runs in your terminal and assists coding workflows through natural language.

1) Install

Global installation:

npm install -g @memo-code/memo
# or use pnpm / yarn / bun

Verify installation (current version does not provide memo --help; help is available in TUI /help; mcp subcommand has standalone help):

memo mcp help

2) Configure API Key (Environment Variable)

Memo reads API keys from the environment variable defined by provider config (for example DEEPSEEK_API_KEY) and also supports OPENAI_API_KEY.

Examples (choose one):

export DEEPSEEK_API_KEY=your_key
# or
export OPENAI_API_KEY=your_key

3) Start Using Memo

Interactive Mode (Recommended)

memo

On first run, if no config file is found, Memo enters the TUI setup flow and creates ~/.memo/config.toml (you can relocate it with MEMO_HOME; see the Configuration doc).

One-shot Mode (--once, good for scripts/pipelines)

memo "Explain how to fix this error" --once

You can also read from stdin (non-TTY automatically uses one-shot mode):

echo "Summarize this repository structure" | memo --once

Dangerous Mode (Skip tool approval, use carefully)

memo --dangerous
# or
memo -d

Next