Skip to content

快速上手

min-agent 是一款在终端里运行的 AI 编程助手。有两种方式开始使用:

前置条件

min-agent 需要 Node.js 20 或更高版本(自带 npm)。先检查是否已安装:

bash
node -v    # 应输出 v20.x 或更高

如果没有安装或版本过低,从 Node.js 官网下载 LTS 版本,或使用版本管理器 nvm 安装:

bash
# macOS / Linux(需先安装 nvm)
nvm install 20
nvm use 20

方式一:全局安装(推荐)

bash
npm install -g min-agent

安装后,在任意目录直接运行 min-agent 即可开始对话。它内置了一个免费可用的模型(OpenRouter openrouter/free),无需注册账号、无需配置,开箱即用。

bash
min-agent             # 开始对话(已内置可用模型)

配置模型(min-agent setup)

内置的 openrouter/free 模型适合先跑起来,但它免费额度有限、稳定性也一般。建议正式使用时运行 min-agent setup 配置你自己的 AI 服务商和模型:

bash
min-agent setup       # 交互式引导:选择服务商、填写 API Key、指定模型

也支持命令行参数直接指定(适合脚本):

bash
min-agent setup --type ollama
min-agent setup --type openai-compatible --url https://api.example.com/v1 --api-key "$KEY" --name groq --default-model llama-3.1-70b
min-agent setup --switch ollama
  • 支持 OpenAI、Ollama,以及任何兼容 OpenAI 接口的服务商
  • 配置保存在 ~/.min-agent/config.json,你配置的服务商优先于内置预设
  • 对话中也可以用 /provider/model 随时切换服务商和模型

方式二:免安装直跑(npx)——临时方案

临时方案

npx 免安装适合临时尝鲜或一次性任务,不建议长期使用。正式使用请用方式一全局安装。

不想安装?用 npx 一条命令直接运行,问完即走:

bash
npx -y min-agent "你的问题或任务"

-y 表示自动确认下载包,首次运行会先下载再执行。例如:

bash
npx -y min-agent "帮我写一个排序函数"
npx -y min-agent "这个目录里都有什么文件?"

两种方式的区别

  • 方式一(推荐):安装一次,历史会话、记忆、/ 命令菜单等完整能力都在,长期使用首选
  • 方式二:仅适合临时尝鲜——每次都要重新下载、缺少完整交互体验,跑完即走

升级到最新版

bash
npm update -g min-agent     # 全局安装的升级
min-agent update            # 或直接运行这个命令

下一步

  • 基本用法 —— 交互会话、单次提问、恢复会话等
  • 配置 —— 添加自己的 AI 服务商

MIT Licensed