文档

开始使用

开始使用

几分钟内完成 Memo 的设置:安装、配置 API 密钥,并运行你的第一个会话。

前置条件#

  • Node.js >= 22
  • 至少一个兼容的 API 密钥(例如 DEEPSEEK_API_KEYOPENAI_API_KEY

安装#

npm install -g @memo-code/memo
# 或
pnpm add -g @memo-code/memo
# 或
yarn global add @memo-code/memo
# 或
bun add -g @memo-code/memo

验证安装:

memo --version

配置 API 密钥#

运行时,Memo 会读取提供商配置的环境变量(config 中的 env_api_key)。

示例:

export DEEPSEEK_API_KEY=your_key
# 或
export OPENAI_API_KEY=your_key

首次运行(推荐:TUI)#

以交互模式启动 Memo:

memo

首次运行时会发生什么:

  • 如果 Memo 可以使用现有的环境密钥配合默认提供商设置,它会自动写入 ~/.memo/config.toml
  • 否则,TUI 设置会要求输入提供商名称、密钥环境变量、模型和基础 URL,然后写入配置。

纯文本模式(管道/脚本)#

当 stdin/stdout 不是 TTY 时,Memo 以纯文本模式运行。

echo "Summarize this repository structure" | memo

在脚本和 CI 中使用纯文本模式。对于交互式审批和更丰富的工作流,请使用 TUI 模式。

单次执行与会话续接#

  • 单次执行:memo --once "your prompt"(或 memo -once "your prompt")。
  • 续接当前目录最近会话:memo --prev(或 memo -prev)。

危险模式#

跳过审批提示:

memo --dangerous
# 或
memo -d

仅在受信任的仓库和受控环境中使用此模式。

其他入口#

除了交互式会话,Memo 还提供独立的子命令:

memo init               # 为当前项目生成 AGENTS.md
memo mcp list           # 列出已配置的 MCP 服务器
memo skills list        # 列出发现的 skills

完整说明见 MCP 集成Skills 系统

下一步#