nami

一个 AI Agent CLI 工具 —— 在终端中完成项目理解、自主查 BUG、代码重构、测试生成、Wiki 生成等开发任务。

Why

Nami 将 AI 能力无缝嵌入日常 CLI 工作流，你无需离开终端、粘贴代码到 Web 界面，一切在本地项目目录内完成：

• 🤖 Agent 自主循环 —— 自动感知上下文 → 规划步骤 → 执行工具 → 反思调整
• 🔧 安全工具调用 —— 文件读写、代码搜索、Shell 命令，危险操作需用户审批
• 🧠 记忆持久化 —— 记住项目偏好、历史错误、常用模式，越用越聪明
• 📂 项目上下文理解 —— 自动构建项目快照（目录树、AST 符号、Git 状态）
• 🔌 多模型适配 —— 统一接口支持 Anthropic / OpenAI，自由切换
• 🖥 交互式 TUI —— 基于 Ink（React for CLI）的多轮对话，流式输出，实时观察推理过程

Quick Start

环境要求

• Node.js >= 22

安装

npm install -g nami-cli

开始使用

# 进入项目目录
cd /path/to/your/project

# 启动交互式对话
nami

# 代码解释
nami explain src/app.ts

# 自主查 BUG
nami bug "用户登录后页面白屏"

# 代码重构
nami refactor "将数据库查询改为异步模式"

# 生成测试
nami test src/utils/helper.ts

# 自动生成项目 Wiki
nami wiki

Working Modes

Nami 有两条执行路径，自动根据输入复杂度路由：

| 模式 | 入口 | 流程 | 适用场景 | |------|------|------|----------| | Chat 模式 | 快速通道 | 记忆召回 → ReAct 循环 → 记忆保存 | 简单问答、单步操作 | | Plan 模式 | 自主引擎 | 规划 → 审批 → 分波执行 → 反思 | 多步骤任务、复杂重构 |

用户输入 → classifyIntent
            ├── Chat  → AgentLoop (快速)
            └── Plan  → AgentEngine (自主)
                          ├── Planner  → 生成计划
                          ├── Executor → 分波并发执行
                          └── Reflector → 反思决策

Configuration

Nami 支持多级配置，优先级从高到低：

1. 环境变量: NAMI_PROVIDER, NAMI_BASE_URL, NAMI_API_KEY, NAMI_MODEL
2. 项目级: ./.nami/config.json
3. 全局级: ~/.nami/config.json

{
  "provider": "anthropic",
  "model": "claude-sonnet-4-20250514",
  "maxIterations": 10,
  "tools": {
    "execute": { "enabled": true, "requireApproval": true }
  }
}

License

MIT