niumagents-cli 0.1.1

package/.niumignore

@@ -0,0 +1,14 @@
+# Ignore node_modules
+node_modules/
+
+# Ignore distribution directories
+dist/
+
+# Ignore directories starting with dot
+.*
+# Except .git directory
+!.git
+# Except .gitignore file
+!.gitignore
+# Except .nium file
+!.nium

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 niuma996
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,281 @@
+# NiumAgents-CLI
+
+## 📦 安装
+
+### 全局安装
+
+```bash
+npm install -g niumagents-cli
+```
+
+## 🚀 使用方法
+
+### 启动应用
+
+全局安装后，可以直接使用：
+
+```bash
+nium
+```
+
+### 模型配置
+
+配置示例（`.nium/config.json`）：
+
+```json
+{
+  "models": {
+    "defaultModel": {
+      "apiKey": "your-api-key-here",
+      "baseURL": "https://api.openai.com/v1",
+      "model": "gpt-4o",
+      "provider": "openai", // openai(OpenAI兼容) / anthropic
+      "maxToken": 128000
+    }
+    // 可选配置
+    // "liteModel": {
+    //   "apiKey": "your-api-key-here",
+    //   "baseURL": "https://api.openai.com/v1",
+    //   "model": "gpt-3.5-turbo",
+    //   "provider": "openai",
+    //   "maxToken": 16385
+    // }
+  }
+}
+```
+
+### 基本工作流程
+
+```bash
+# 1. 启动CLI
+nium
+
+# 2. 开始一个任务（可以省略 /chat 命令）
+nium> 帮我创建一个用户管理模块
+
+# 或明确使用命令
+nium> /chat 帮我创建一个用户管理模块
+
+# 3. 如果任务中断，恢复会话
+nium> /resume
+
+# 4. 完成后清空会话
+nium> /clear
+```
+
+## 📖 可用命令
+
+### 任务管理命令
+
+| 命令 | 说明 | 示例 |
+|------|------|------|
+| `<request>` | 开始新任务（默认命令） | `帮我实现登录功能` |
+| `/chat <request>` | 明确指定开始新任务 | `/chat 创建API接口` |
+| `/resume` | 恢复中断的会话 | `/resume` |
+| `/clear` | 归档并清空当前会话 | `/clear` |
+
+### 开发辅助命令
+
+| 命令 | 说明 | 示例 |
+|------|------|------|
+| `/commit` | 使用AI生成commit message并提交 | `/commit` |
+| `/list_tools` | 列出所有可用的工具和代理 | `/list_tools` |
+| `/history` | 查看归档的会话历史 | `/history` |
+
+### 系统命令
+
+| 命令 | 说明 | 示例 |
+|------|------|------|
+| `/help` | 显示帮助信息 | `/help` |
+| `/exit` 或 `/quit` | 退出应用 | `/exit` |
+
+### 命令提示
+
+- 输入 `/` 后可以使用**模糊搜索**来快速找到命令
+- 大多数命令都有简短的别名（如 `/h` = `/help`）
+
+## 🎯 子代理系统
+
+子代理是具有特定领域专长的智能体，能够更专业地处理特定类型的任务。
+
+
+### 自定义子代理
+
+你可以创建自己的子代理来处理特定任务。
+
+#### 创建自定义代理
+
+在 `.nium/agents/` 目录下创建 `.md` 文件：
+
+```markdown
+---
+name: translator
+description: 翻译助手，帮助翻译代码注释和文档
+keywords: 翻译, translate, 中英文, translation
+---
+
+你是一位翻译助手。你的任务是帮助翻译代码注释、文档和技术文本。
+
+## 核心职责
+
+1. 翻译代码注释（中文↔英文）
+2. 翻译技术文档
+3. 保持技术术语的准确性
+
+## 工作流程
+
+1. 读取需要翻译的文件
+2. 识别需要翻译的内容
+3. 进行准确的翻译
+4. 保持格式和代码不变
+```
+
+## ⚙️ 配置
+
+### .nium 目录结构
+
+`.nium/` 目录包含所有配置文件和会话数据，该目录已添加到 `.gitignore`。
+
+```
+.nium/
+├── .env                    # 环境变量配置
+├── config.json             # 全局配置
+├── session.jsonl           # 当前会话数据（用于恢复）
+├── agents/                 # 自定义子代理配置 ⭐
+│   ├── commit-helper.md
+│   ├── translator.md
+│   └── your-agent.md
+├── archives/               # 历史会话归档
+│   └── session-*.jsonl
+└── docs/                   # 项目结构文档
+    └── PROJECT_STRUCTURE.md
+```
+
+### 环境变量配置
+
+在 `.nium/.env` 文件中可以配置以下环境变量：
+
+#### 功能开关
+
+```bash
+# 启用上下文隔离模式（推荐）
+USE_LLM_DISCLOSURE=true
+
+# 启用LLM生成高质量摘要
+USE_LLM_SUMMARY=true
+
+```
+
+
+### 项目规则文件（可选）
+
+创建 `.nium/rules.md` 文件来定义项目特定的规则和约定
+
+该文件用于告诉AI助手项目的编码规范、架构约定、开发流程等信息。
+
+## 🛠️ 可用工具
+
+系统提供了丰富的工具集，可通过 `/list_tools` 命令查看完整列表。
+
+### 文件操作工具
+
+- `read(path)` - 读取文件内容
+- `write(path, content)` - 写入文件
+- `merge(path, content)` - 智能合并内容到文件
+- `delete(path)` - 删除文件
+- `mkdir(path)` - 创建目录
+- `searchReplace(pattern, replacement, path)` - 查找替换
+
+### 代码搜索工具
+
+- `glob(pattern)` - 通过模式匹配文件
+- `grep(pattern, path)` - 在文件中搜索内容
+
+### Git工具
+
+- `shell(command)` - 执行shell命令（包括git命令）
+
+### 项目分析工具
+
+- `quickProjectScan()` - 快速扫描项目结构并生成文档
+
+### 智能体工具
+
+- `think(thought)` - 记录思考过程
+- `askUser(question)` - 向用户提问
+
+### MCP工具（可选）
+
+如果配置了MCP服务器，还可以使用额外的工具。详见MCP配置文档。
+
+## 🎨 使用示例
+
+### 示例1：创建新功能
+
+```bash
+nium> 帮我创建一个用户认证模块，包括登录、注册和token验证
+```
+
+### 示例2：代码审查
+
+```bash
+nium> 审查 src/api/user.ts 文件，找出潜在问题
+```
+
+### 示例3：生成commit message
+
+```bash
+# 修改代码后
+nium> /commit
+```
+
+### 示例4：探索项目
+
+```bash
+nium> 探索这个项目的结构
+```
+
+
+### MCP集成
+
+支持Model Context Protocol，可以通过MCP服务器扩展更多功能。配置完成后重新启动，通过 /list_tools 命令查看
+
+配置示例（`.nium/config.json`）：
+
+```json
+{
+  "models": {
+    "defaultModel": {
+      "apiKey": "your-api-key-here",
+      "baseURL": "https://api.openai.com/v1",
+      "model": "gpt-4o",
+      "provider": "openai", 
+      "maxToken": 128000
+    },
+    "liteModel": {
+      "apiKey": "your-api-key-here",
+      "baseURL": "https://api.openai.com/v1",
+      "model": "gpt-3.5-turbo",
+      "provider": "openai",
+      "maxToken": 16385
+    }
+  },
+  "mcpServers": [
+    {
+      "name": "example-http-server",
+      "description": "Example HTTP MCP server",
+      "transport": "http",
+      "url": "http://localhost:3000",
+      "headers": {
+        "Authorization": "Bearer your-token-here"
+      },
+      "timeout": 30000,
+      "enabled": false
+    }
+  ]
+}
+```
+
+## 📝 许可证
+
+MIT License - 详见 [LICENSE](https://github.com/niuma996/niumagents-cli?tab=MIT-1-ov-file) 文件

package/bin/nium

@@ -0,0 +1,7 @@
+#!/usr/bin/env node --no-deprecation
+
+// 这个文件作为CLI的入口点，直接调用主模块
+import('../dist/nium.js').catch(err => {
+  console.error('Failed to start nium:', err);
+  process.exit(1);
+});