xiaozhou-chat 1.0.0 → 1.0.2

package/README.md

@@ -1,28 +1,162 @@
-# my-newapi-chat
+```markdown
+# xiaozhou-chat
 
 CLI chatbot based on NewAPI.
 
-## 安装
-npm i -g my-newapi-chat
+---
 
-## 配置
+## ✨ 特性
+- 基于 NewAPI 的命令行聊天工具
+- 支持自定义模型与 Base URL
+- 自动保存历史记录（项目根目录优先）
+- Node.js 18+ 支持
+
+---
+
+## 📦 安装
+
+全局安装：
+```bash
+npm i -g xiaozhou-chat
+```
+
+---
+
+## ⚙️ 配置
+
+### 环境变量（推荐）
+必填：
+```bash
 export NEWAPI_API_KEY="你的Key"
+```
 
 可选：
+```bash
 export NEWAPI_BASE_URL="https://api.newapi.pro/v1"
 export NEWAPI_MODEL="gpt-3.5-turbo"
+```
+
+### 配置说明表
+
+| 变量名 | 是否必填 | 说明 | 示例 |
+|---|---|---|---|
+| NEWAPI_API_KEY | 必填 | NewAPI 的 API Key | `sk-xxxx` |
+| NEWAPI_BASE_URL | 可选 | NewAPI 请求地址 | `https://api.newapi.pro/v1` |
+| NEWAPI_MODEL | 可选 | 默认模型 | `gpt-3.5-turbo` |
+
+---
+
+## 📁 配置与历史记录位置
+
+**项目根目录判定规则：**
+从当前目录向上查找最近的 `package.json`，其所在目录为项目根目录。
+
+### ✅ 配置文件优先级
+1. 项目根目录：
+   - `.newapi-chat-config.json`
+   - `newapi-chat.config.json`
+2. 用户目录：
+   - `~/.newapi-chat-config.json`
+
+### ✅ 历史记录保存位置
+- 优先保存到项目根目录：
+  ```
+  <项目根>/.newapi-chat-history.json
+  ```
+- 无写入权限时回退：
+  ```
+  ~/.newapi-chat-history.json
+  ```
+
+### ✅ 历史导出（Markdown）
+- 优先导出到项目根目录：
+  ```
+  <项目根>/newapi-chat-history.md
+  ```
+- 无写入权限时回退：
+  ```
+  ~/newapi-chat-history.md
+  ```
+
+---
+
+## 🚀 使用
+
+### 基础启动
+```bash
+xiaozhou-chat
+```
+
+### 自定义模型与地址
+```bash
+xiaozhou-chat --model gpt-4 --base-url https://api.newapi.pro/v1
+```
 
-## 使用
-newapi-chat
+---
 
-## CLI 参数
-newapi-chat --model gpt-4 --base-url https://api.newapi.pro/v1
+## 🧰 CLI 参数说明
 
-## 历史记录
-默认保存在：
-~/.newapi-chat-history.json
+| 参数 | 说明 | 示例 |
+|---|---|---|
+| --model | 指定模型 | `--model gpt-4` |
+| --base-url | 指定 API 地址 | `--base-url https://api.newapi.pro/v1` |
 
-## Windows 打包
+---
+
+## 💬 使用示例
+
+启动后输入内容即可对话：
+
+```
+$ xiaozhou-chat
+> 你好
+你好！有什么可以帮你？
+> 介绍一下 NewAPI
+NewAPI 是一个兼容 OpenAI 接口的网关服务...
+```
+
+退出方式：
+- `Ctrl + C`
+- 或输入 `exit`
+
+---
+
+## 🪟 Windows 打包
+
+安装 pkg：
+```bash
 npm i -g pkg
+```
+
+执行打包：
+```bash
 npm run build:win
+```
+
+生成文件：
+```
 dist/newapi-chat.exe
+```
+
+---
+
+## 🧩 脚本说明
+
+`package.json` 中包含：
+```json
+"scripts": {
+  "build:win": "pkg . --targets node18-win-x64 --output dist/newapi-chat.exe"
+}
+```
+
+---
+
+## 🧾 依赖
+
+- minimist
+
+---
+
+## 📄 许可证
+MIT
+```

package/bin/cli.js

@@ -7,11 +7,30 @@ import minimist from "minimist";
 
 const args = minimist(process.argv.slice(2));
 
-const configFile = path.join(os.homedir(), ".newapi-chat-config.json");
-const historyFile = path.join(os.homedir(), ".newapi-chat-history.json");
+function findProjectRoot(startDir = process.cwd()) {
+  let dir = startDir;
+  while (true) {
+    if (fs.existsSync(path.join(dir, "package.json"))) {
+      return dir;
+    }
+    const parent = path.dirname(dir);
+    if (parent === dir) break;
+    dir = parent;
+  }
+  return startDir;
+}
+
+const projectRoot = findProjectRoot();
+
+const homeConfigFile = path.join(os.homedir(), ".newapi-chat-config.json");
+const projectConfigFile = path.join(projectRoot, ".newapi-chat-config.json");
+const projectAltConfigFile = path.join(projectRoot, "newapi-chat.config.json");
+
+const homeHistoryFile = path.join(os.homedir(), ".newapi-chat-history.json");
+const projectHistoryFile = path.join(projectRoot, ".newapi-chat-history.json");
 
 function initConfigFile() {
-  if (fs.existsSync(configFile)) return;
+  if (fs.existsSync(homeConfigFile)) return;
 
   const defaultConfig = {
     apiKey: "",
@@ -19,42 +38,127 @@ function initConfigFile() {
     model: "gpt-3.5-turbo"
   };
 
-  fs.writeFileSync(configFile, JSON.stringify(defaultConfig, null, 2), "utf-8");
-  console.log(`✅ 已创建配置文件: ${configFile}`);
+  fs.writeFileSync(homeConfigFile, JSON.stringify(defaultConfig, null, 2), "utf-8");
+  console.log(`✅ 已创建配置文件: ${homeConfigFile}`);
   console.log("👉 请编辑该文件填入 apiKey");
 }
 
-function loadConfig() {
-  if (!fs.existsSync(configFile)) return {};
+function loadConfigFrom(file) {
+  if (!fs.existsSync(file)) return {};
   try {
-    return JSON.parse(fs.readFileSync(configFile, "utf-8"));
+    return JSON.parse(fs.readFileSync(file, "utf-8"));
   } catch {
     return {};
   }
 }
 
+function loadConfig() {
+  const home = loadConfigFrom(homeConfigFile);
+  const project =
+    loadConfigFrom(projectConfigFile) ||
+    loadConfigFrom(projectAltConfigFile);
+
+  return { ...home, ...project };
+}
+
+function canWriteProjectDir() {
+  try {
+    fs.accessSync(projectRoot, fs.constants.W_OK);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+function getReadHistoryFile() {
+  return fs.existsSync(projectHistoryFile)
+    ? projectHistoryFile
+    : homeHistoryFile;
+}
+
+function getWriteHistoryFile() {
+  return canWriteProjectDir()
+    ? projectHistoryFile
+    : homeHistoryFile;
+}
+
+function getExportFile() {
+  const dir = canWriteProjectDir() ? projectRoot : os.homedir();
+  return path.join(dir, "newapi-chat-history.md");
+}
+
 function loadHistory() {
-  if (!fs.existsSync(historyFile)) return [];
+  const target = getReadHistoryFile();
+  if (!fs.existsSync(target)) return [];
   try {
-    return JSON.parse(fs.readFileSync(historyFile, "utf-8"));
+    return JSON.parse(fs.readFileSync(target, "utf-8"));
   } catch {
     return [];
   }
 }
 
 function saveHistory(messages) {
-  fs.writeFileSync(historyFile, JSON.stringify(messages, null, 2));
+  const target = getWriteHistoryFile();
+  fs.writeFileSync(target, JSON.stringify(messages, null, 2));
+}
+
+function clearHistory() {
+  const target = getWriteHistoryFile();
+  fs.writeFileSync(target, JSON.stringify([], null, 2));
+}
+
+function showHistory(messages, limit) {
+  if (!messages.length) {
+    console.log("（暂无历史）");
+    return;
+  }
+  const list = limit ? messages.slice(-limit) : messages;
+  list.forEach((m, i) => {
+    const role = m.role === "user" ? "你" : "助手";
+    console.log(`[${i + 1}] ${role}: ${m.content}`);
+  });
+}
+
+function exportHistory(messages) {
+  if (!messages.length) {
+    console.log("（暂无历史）");
+    return;
+  }
+  const md = messages.map((m) => {
+    const role = m.role === "user" ? "你" : "助手";
+    return `### ${role}\n\n${m.content}\n`;
+  }).join("\n");
+
+  const file = getExportFile();
+  fs.writeFileSync(file, md, "utf-8");
+  console.log(`✅ 已导出: ${file}`);
+}
+
+function showHelp() {
+  console.log(`
+可用命令：
+  /help           显示帮助
+  /history [N]    显示历史（可选最近 N 条）
+  /clear          清空历史
+  /export         导出历史为 Markdown
+  exit            退出（或按 ESC）
+`);
 }
 
 initConfigFile();
 const config = loadConfig();
 
-const API_KEY = config.apiKey || process.env.NEWAPI_API_KEY;
+const API_KEY =
+  config.apiKey ||
+  args["api-key"] ||
+  process.env.NEWAPI_API_KEY;
+
 const BASE_URL =
   config.baseUrl ||
   args["base-url"] ||
   process.env.NEWAPI_BASE_URL ||
   "https://api.newapi.pro/v1";
+
 const MODEL =
   config.model ||
   args["model"] ||
@@ -74,7 +178,23 @@ const rl = readline.createInterface({
   prompt: "你> "
 });
 
-console.log("✅ NewAPI Chat CLI 已启动，输入 exit 退出");
+readline.emitKeypressEvents(process.stdin);
+if (process.stdin.isTTY) {
+  process.stdin.setRawMode(true);
+}
+
+process.stdin.on("keypress", (_, key) => {
+  if (key && key.name === "escape") {
+    rl.close();
+  }
+});
+
+rl.on("close", () => {
+  console.log("\n👋 已退出");
+  process.exit(0);
+});
+
+console.log("✅ NewAPI Chat CLI 已启动，输入 /help 查看命令");
 
 async function chatStream(userInput) {
   messages.push({ role: "user", content: userInput });
@@ -134,6 +254,30 @@ rl.prompt();
 rl.on("line", async (line) => {
   const input = line.trim();
   if (!input) return rl.prompt();
+
+  if (input === "/help") {
+    showHelp();
+    return rl.prompt();
+  }
+
+  if (input.startsWith("/history")) {
+    const n = Number(input.split(/\s+/)[1]);
+    showHistory(messages, Number.isFinite(n) && n > 0 ? n : undefined);
+    return rl.prompt();
+  }
+
+  if (input === "/clear") {
+    clearHistory();
+    messages = [];
+    console.log("✅ 历史已清空");
+    return rl.prompt();
+  }
+
+  if (input === "/export") {
+    exportHistory(messages);
+    return rl.prompt();
+  }
+
   if (input === "exit" || input === "quit") {
     rl.close();
     return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xiaozhou-chat",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "CLI chatbot based on NewAPI",
   "bin": {
     "xiaozhou-chat": "bin/cli.js"