ningzhi-agent-cli 0.0.1 → 0.1.0

package/README.md

@@ -1,35 +1,214 @@
-# Ningzhi
+# 柠智
 
-A personal AI Agent like OpenClaw, including tools, skills, memory, hook, sub-agent, MCP sever, etc. Run in the terminal.
+Ningzhi
 
-## tech
+**柠智 NingzhiAgentCli 🤖 是一个 AI Agent 个人助手，像 OpenClaw 小龙虾一样。** 包含 tools、skills、memory、hook、subagent、MCP-server 等 Agent 功能。你可以和它聊天，给它分配任务，让它操作文件 等等
 
-- runtime: nodejs
-- language: typescript
-- package tool: pnpm
-- agent framework: langGraph
-- LLM API: moonshot kimi
-- CLI tool: commander.js
+## 技术栈
 
-需要新建一个文件 `~/.ningzhiAgentCli/ningzhi.json` 格式如下
+- runtime：Node.js（>= 22）
+- language：TypeScript
+- package tool：pnpm
+- agent framework：LangGraph
+- LLM API：Moonshot Kimi（兼容任意 OpenAI 格式接口）
+- CLI tool：commander.js
 
-```js
+## 安装
+
+本地安装 Node.js，版本要求 >= 22，执行如下命令安装 Ningzhi：
+
+> 【注意】Windows 操作系统，请使用管理员身份打开 cmd 或 PowerShell，再执行命令。
+
+```bash
+npm i ningzhi-agent-cli -g
+```
+
+能查看到 Ningzhi 的版本号，说明安装成功：
+
+```bash
+ningzhi --version
+```
+
+运行 ningzhi 命令启动：
+
+```bash
+ningzhi
+```
+
+升级到最新版：
+
+```bash
+npm update ningzhi-agent-cli -g
+```
+
+## Config
+
+柠智 Ningzhi 初次运行时，会自动创建配置文件 **`~/.ningzhiAgentCli/ningzhi.json`**，你至少需要配置 2 项：
+
+1. `model`：大模型的名称、API key 和 baseURL，下面是 [kimi](https://platform.kimi.com/docs/guide/start-using-kimi-api) 的示例，其他模型见下文。
+2. `TAVILY_API_KEY`：[Tavily Search API](https://app.tavily.com/home) 的 API key，用于 Agent 做网络搜索。
+
+```json
 {
   "model": {
-    "model": "qwen-plus", // 支持 kimi minimax glm xiaomi deepseek qwen ...
-    "apiKey": "xxx",
-    "baseURL": "https://dashscope.aliyuncs.com/compatible-mode/v1"
+    "model": "kimi-k2.6",
+    "apiKey": "sk-xxx",
+    "baseURL": "https://api.moonshot.cn/v1"
   },
   "env": {
-    "TAVILY_API_KEY": "xxx"
+    "TAVILY_API_KEY": "tvly-dev-xxx"
+  }
+}
+```
+
+配置完成后重新运行 `ningzhi` 即可。
+
+## Models
+
+> 【注意】一些免费大模型（如 GLM-4-Flash）可能会存在兼容性问题。
+
+1. Kimi：https://platform.kimi.com/docs/guide/start-using-kimi-api
+
+```json
+{
+  "model": {
+    "model": "kimi-k2.6",
+    "apiKey": "sk-xxx",
+    "baseURL": "https://api.moonshot.cn/v1"
+  }
+}
+```
+
+2. DeepSeek：https://api-docs.deepseek.com/zh-cn/
+
+```json
+{
+  "model": {
+    "model": "deepseek-v4-pro",
+    "apiKey": "sk-xxx",
+    "baseURL": "https://api.deepseek.com"
+  }
+}
+```
+
+3. MiniMax：https://platform.minimaxi.com/docs/guides/quickstart-preparation
+
+```json
+{
+  "model": {
+    "model": "MiniMax-M3",
+    "apiKey": "sk-api-xxx",
+    "baseURL": "https://api.minimaxi.com/v1"
+  }
+}
+```
+
+4. GLM 智谱：https://docs.bigmodel.cn/cn/guide/develop/langchain/introduction
+
+```json
+{
+  "model": {
+    "model": "GLM-5.1",
+    "apiKey": "xxx",
+    "baseURL": "https://open.bigmodel.cn/api/paas/v4/"
   }
 }
 ```
 
-## command
+5. 通义千问 QWEN：https://bailian.console.aliyun.com/cn-beijing#/home
+
+```json
+{
+  "model": {
+    "model": "qwen-plus",
+    "apiKey": "sk-ws-xxx",
+    "baseURL": "https://dashscope.aliyuncs.com/compatible-mode/v1"
+  }
+}
+```
+
+6. 小米 MiMo：https://mimo.mi.com/docs/zh-CN/quick-start/summary/first-api-call
+
+```json
+{
+  "model": {
+    "model": "mimo-v2.5-pro",
+    "apiKey": "xxx",
+    "baseURL": "https://api.xiaomimimo.com/v1"
+  }
+}
+```
+
+其他模型，只要符合 OpenAI 接口格式，都能支持。
+
+## Skills
+
+1. 手动安装第三方 skill：Anthropic 提供了很多常用 [skills](https://github.com/anthropics/skills/tree/main/skills) 可以选择安装，例如：
+
+```bash
+npx skills add https://github.com/anthropics/skills/tree/main/skills/pdf
+```
+
+2. 在 Agent 中聊天对话，让它来安装一个第三方 skill：
+
+```text
+帮我查找关于 pdf 的 skill 并安装最流行的那个
+```
+
+3. 在 Agent 中聊天对话，让它来创建一个新 skill：
+
+```text
+帮我创建一个 skill 专门用来提出反对意见，防止我只看到正面价值，看不到负面影响
+```
+
+## MCP Server
+
+打开配置文件 `~/.ningzhiAgentCli/ningzhi.json`，可以配置 MCP Server，格式如下：
+
+```json
+{
+  "mcpServers": {
+    "playwright": {
+      "command": "npx",
+      "args": ["-y", "@playwright/mcp@latest"]
+    },
+    "github": {
+      "url": "https://api.githubcopilot.com/mcp/",
+      "headers": {
+        "Authorization": "Bearer github_pat_xxx"
+      }
+    }
+  }
+}
+```
+
+## Hooks
+
+打开配置文件 `~/.ningzhiAgentCli/ningzhi.json`，可以配置 hooks，格式如下：
+
+```json
+{
+  "hooks": {
+    "PreToolUse": [
+      { "matcher": "exec", "command": "echo 'Checking command...'" },
+      {
+        "matcher": "read_file",
+        "command": "~/.ningzhiAgentCli/hooks/protect_env.sh"
+      }
+    ],
+    "PostToolUse": [
+      { "matcher": "*", "command": "~/.ningzhiAgentCli/hooks/record_tool.sh" }
+    ]
+  }
+}
+```
+
+## Development
+
+克隆仓库后，在项目根目录执行：
 
 ```bash
-pnpm dev
-pnpm test
-pnpm build
+pnpm dev      # 本地开发运行（ts-node）
+pnpm test     # 运行测试
+pnpm build    # 编译 TypeScript 到 dist/
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ningzhi-agent-cli",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "A personal AI Agent like OpenClaw, including tools, skills, memory, hook, sub-agent, MCP sever, etc. Run in the terminal.",
   "type": "commonjs",
   "main": "dist/index.js",