@unity-china/codely-cli 1.0.0-rc.2 → 1.0.0-rc.4

package/README.md

@@ -1,332 +0,0 @@
-# Codely CLI
-
-<div align="center">
-
-![Codely CLI Screenshot](https://internal-api-drive-stream.feishu.cn/space/api/box/stream/download/v2/cover/SDRJbcEfUoQRsVxcPJ8ccKTdnMc/?fallback_source=1&height=1280&mount_node_token=JRnkdygOJoQcpyxlCQncsGtMnTc&mount_point=docx_image&policy=equal&width=1280)
-
-[![npm version](https://img.shields.io/npm/v/@unity-china/codely-cli.svg)](https://www.npmjs.com/package/@unity-china/codely-cli)
-[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](./LICENSE)
-[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org/)
-[![Downloads](https://img.shields.io/npm/dm/@unity-china/codely-cli.svg)](https://www.npmjs.com/package/@unity-china/codely-cli)
-
-**AI-powered command-line workflow tool for developers**
-
-🌐 [Official Website](https://codely.tuanjie.cn/) • 📖 [Documentation](https://yousandi.feishu.cn/wiki/Sqmlw31sYiTm8qkh7s1cSlbenmb) • 🇨🇳 [中文文档](https://yousandi.feishu.cn/wiki/Sqmlw31sYiTm8qkh7s1cSlbenmb)
-
-[Installation](#installation) • [Quick Start](#quick-start) • [Features](#key-features)
-
-</div>
-
-## Key Features
-
-- **Code Understanding & Editing** - Query and edit large codebases beyond traditional context window limits
-- **Workflow Automation** - Automate operational tasks like handling pull requests and complex rebases
-- **AI Agent System** - Specialized intelligent agents for deep codebase analysis and automated tasks
-- **MCP Integration** - Extend capabilities with Model Context Protocol servers for external tools and services
-- **Unity Integration** - Direct integration with Unity/Tuanjie Engine for game development tasks
-- **Screenshot Analysis** - Analyze screenshots and images to understand UI/UX and extract information
-- **Sandboxing** - Secure execution environment with multiple sandboxing modes
-- **IDE Plugin** - VS Code extension for seamless integration
-- **ACP Support** - Agent Client Protocol integration for editors like Zed ([User Guide](docs/users/acp-guide-CN.md))
-
-## 🤖 AI Agent System
-
-Codely CLI includes a powerful agent system with specialized AI assistants for complex development tasks:
-
-### Agent Usage
-
-**Interactive Mode** (agents invoked automatically):
-
-```bash
-codely
-> Analyze this React project's component architecture and identify performance bottlenecks
-```
-
-**Non-Interactive Mode** with different output formats:
-
-```bash
-# Standard text output
-codely --prompt "Analyze the API endpoints and security measures"
-
-# JSON output for automation
-codely --output-format json --prompt "Investigate the codebase structure" > analysis.json
-
-# Streaming JSON for real-time monitoring
-codely --output-format stream-json --prompt "Document the data flow" | jq '.type == "agent_think"'
-```
-
-### Agent Management
-
-**List available agents:**
-
-```bash
-/agents list
-```
-
-**Create custom agents:**
-
-```bash
-# Project-level agent
-/agents create security-auditor
-
-# Global agent
-/agents create my-helper --global
-
-# With custom description
-/agents create api-analyzer "Analyzes API endpoints and documentation"
-```
-
-**Agent locations:**
-
-- **Project agents**: `.codely-cli/agents/` (shared with team)
-- **Global agents**: `~/.codely-cli/agents/` (personal use)
-
-### Example Agent Output
-
-Agents provide structured, comprehensive results:
-
-**Interactive Progress:**
-
-```
-🚀 Delegating to codebase_investigator subagent...
-🔧 [1] List Directory - scanning project structure
-✅ List Directory finished - 45 directories found
-🤖💭 Analyzing package.json dependencies...
-🔧 [2] Read File - package.json
-✅ Read File finished - analyzing dependencies
-📋 Result:
-{
-  "SummaryOfFindings": "React application with 3-tier architecture...",
-  "ExplorationTrace": ["Analyzed project structure", "Examined routing"],
-  "RelevantLocations": ["src/components/App.tsx", "src/api/routes.ts"]
-}
-```
-
-## Installation
-
-### Prerequisites
-
-Ensure you have [Node.js version 20](https://nodejs.org/en/download) or higher installed.
-
-### Install directly
-
-```bash
-npm i @unity-china/codely-cli
-```
-
-## Quick Start
-
-```bash
-# Start
-codely
-
-# Example commands
-> Explain this codebase structure
-> Help me refactor this function
-> Generate unit tests for this module
-```
-
-### Session Management
-
-Control your token usage with configurable session limits to optimize costs and performance.
-
-#### Configure Session Token Limit
-
-Create or edit `.codely-cli/settings.json` in your home directory:
-
-```json
-{
-  "sessionTokenLimit": 32000
-}
-```
-
-#### Session Commands
-
-- **`/compress`** - Compress conversation history to continue within token limits
-- **`/clear`** - Clear all conversation history and start fresh
-- **`/stats`** - Check current token usage and limits
-
-> 📝 **Note**: Session token limit applies to a single conversation, not cumulative API calls.
-
-## Usage Examples
-
-### 🔍 Explore Codebases
-
-```bash
-cd your-project/
-codely
-
-# Architecture analysis
-> Describe the main pieces of this system's architecture
-> What are the key dependencies and how do they interact?
-> Find all API endpoints and their authentication methods
-```
-
-### 💻 Code Development
-
-```bash
-# Refactoring
-> Refactor this function to improve readability and performance
-> Convert this class to use dependency injection
-> Split this large module into smaller, focused components
-
-# Code generation
-> Create a REST API endpoint for user management
-> Generate unit tests for the authentication module
-> Add error handling to all database operations
-```
-
-### 🔄 Automate Workflows
-
-```bash
-# Git automation
-> Analyze git commits from the last 7 days, grouped by feature
-> Create a changelog from recent commits
-> Find all TODO comments and create GitHub issues
-
-# File operations
-> Convert all images in this directory to PNG format
-> Rename all test files to follow the *.test.ts pattern
-> Find and remove all console.log statements
-```
-
-### 🐛 Debugging & Analysis
-
-```bash
-# Performance analysis
-> Identify performance bottlenecks in this React component
-> Find all N+1 query problems in the codebase
-
-# Security audit
-> Check for potential SQL injection vulnerabilities
-> Find all hardcoded credentials or API keys
-```
-
-## Popular Tasks
-
-### 📚 Understand New Codebases
-
-```text
-> What are the core business logic components?
-> What security mechanisms are in place?
-> How does the data flow through the system?
-> What are the main design patterns used?
-> Generate a dependency graph for this module
-```
-
-### 🔨 Code Refactoring & Optimization
-
-```text
-> What parts of this module can be optimized?
-> Help me refactor this class to follow SOLID principles
-> Add proper error handling and logging
-> Convert callbacks to async/await pattern
-> Implement caching for expensive operations
-```
-
-### 📝 Documentation & Testing
-
-```text
-> Generate comprehensive JSDoc comments for all public APIs
-> Write unit tests with edge cases for this component
-> Create API documentation in OpenAPI format
-> Add inline comments explaining complex algorithms
-> Generate a README for this module
-```
-
-### 🚀 Development Acceleration
-
-```text
-> Set up a new Express server with authentication
-> Create a React component with TypeScript and tests
-> Implement a rate limiter middleware
-> Add database migrations for new schema
-> Configure CI/CD pipeline for this project
-```
-
-## Commands & Shortcuts
-
-### Session Commands
-
-- `/help` - Display available commands
-- `/clear` - Clear conversation history
-- `/compress` - Compress history to save tokens
-- `/stats` - Show current session information
-- `/exit` or `/quit` - Exit Codely CLI
-
-### MCP Commands
-
-Manage Model Context Protocol (MCP) servers to extend Codely capabilities with external tools and services:
-
-- `/mcp` - List configured MCP servers and their available tools
-- `/mcp desc` - Show detailed descriptions of servers and tools
-- `/mcp schema` - Display tool parameter schemas
-- `/mcp auth <server-name>` - Authenticate with OAuth-enabled MCP servers
-- `/mcp refresh` - Refresh the list of MCP servers and tools
-
-CLI commands for managing MCP server configurations:
-
-#### `codely mcp add <name> <commandOrUrl> [args...]`
-
-Add a new MCP server with the specified name and connection details.
-
-**Options:**
-
-- `--scope` (`-s`) - Configuration scope (user or project)
-- `--transport` (`-t`) - Transport type (stdio, sse, http)
-- `--env` (`-e`) - Set environment variables for stdio transport (e.g. `-e KEY=value`)
-- `--header` (`-H`) - Set HTTP headers for SSE and HTTP transports (e.g. `-H "X-Api-Key: abc123"`)
-- `--timeout` - Connection timeout in milliseconds
-- `--trust` - Trust the server (bypass all tool call confirmation prompts)
-- `--description` - Description for the server
-- `--include-tools` - Comma-separated list of tools to include
-- `--exclude-tools` - Comma-separated list of tools to exclude
-
-**Transport Types:**
-
-- `stdio` (default) - Launch a process using the specified command and arguments
-- `sse` - Connect to a server using Server-Sent Events protocol
-- `http` - Connect to a server using HTTP protocol
-
-**Examples:**
-
-```bash
-# Add a stdio server
-codely mcp add my-server python /path/to/server.py --env API_KEY=abc123
-
-# Add an HTTP server
-codely mcp add my-http-server http://localhost:8000 --transport http --header "Authorization: Bearer token"
-
-# Add a server with scoped configuration
-codely mcp add my-server python /path/to/server.py --scope user
-```
-
-#### `codely mcp list`
-
-List all configured MCP servers and their connection status.
-
-#### `codely mcp remove <name>`
-
-Remove an MCP server with the specified name.
-
-**Options:**
-
-- `--scope` (`-s`) - Configuration scope (user or project)
-
-### Keyboard Shortcuts
-
-- `Ctrl+C` - Cancel current operation
-- `Ctrl+D` - Exit (on empty line)
-- `Up/Down` - Navigate command history
-
-## Troubleshooting
-
-If you encounter issues, please check the error messages and ensure:
-
-- Node.js version is 20 or higher
-- All dependencies are properly installed
-- API keys are correctly configured in settings
-
-## License
-
-[LICENSE](./LICENSE)

package/README.zh-CN.md

@@ -1,336 +0,0 @@
-# Codely CLI
-
-<div align="center">
-
-![Codely CLI 截图](https://internal-api-drive-stream.feishu.cn/space/api/box/stream/download/v2/cover/SDRJbcEfUoQRsVxcPJ8ccKTdnMc/?fallback_source=1&height=1280&mount_node_token=JRnkdygOJoQcpyxlCQncsGtMnTc&mount_point=docx_image&policy=equal&width=1280)
-
-[![npm 版本](https://img.shields.io/npm/v/@unity-china/codely-cli.svg)](https://www.npmjs.com/package/@unity-china/codely-cli)
-[![许可证](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](./LICENSE)
-[![Node.js 版本](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org/)
-[![下载量](https://img.shields.io/npm/dm/@unity-china/codely-cli.svg)](https://www.npmjs.com/package/@unity-china/codely-cli)
-
-**面向开发者的 AI 驱动命令行工作流工具**
-
-🌐 [官方网站](https://codely.tuanjie.cn/) • 📖 [使用手册](https://yousandi.feishu.cn/wiki/Sqmlw31sYiTm8qkh7s1cSlbenmb) • 🇺🇸 [English](./README.md)
-
-[安装](#安装) • [快速开始](#快速开始) • [核心功能](#核心功能)
-
-</div>
-
-## 核心功能
-
-- **代码理解与编辑** - 查询和编辑超出传统上下文窗口限制的大型代码库
-- **工作流自动化** - 自动化处理拉取请求和复杂变基等操作任务
-- **AI 智能体系统** - 专业的智能代理，用于深度代码库分析和自动化任务
-- **MCP 集成** - 通过模型上下文协议服务器扩展外部工具和服务能力
-- **Unity 集成** - 与 Unity/团结引擎直接集成，支持游戏开发任务
-- **截图分析** - 分析截图和图像以理解 UI/UX 并提取信息
-- **沙箱环境** - 多种沙箱模式的安全执行环境
-- **IDE 插件** - VS Code 扩展实现无缝集成
-
-## 🤖 AI 智能体系统
-
-Codely CLI 包含强大的智能体系统，提供专业的 AI 助手处理复杂的开发任务：
-
-### 智能体使用
-
-**交互模式**（智能体自动调用）：
-
-```bash
-codely
-> 分析这个 React 项目的组件架构并识别性能瓶颈
-```
-
-**非交互模式**支持不同的输出格式：
-
-```bash
-# 标准文本输出
-codely --prompt "分析 API 端点和安全措施"
-
-# JSON 输出用于自动化
-codely --output-format json --prompt "调查代码库结构" > analysis.json
-
-# 流式 JSON 用于实时监控
-codely --output-format stream-json --prompt "记录数据流" | jq '.type == "agent_think"'
-```
-
-### 智能体管理
-
-**列出可用的智能体：**
-
-```bash
-/agents list
-```
-
-**创建自定义智能体：**
-
-```bash
-# 项目级别智能体
-/agents create security-auditor
-
-# 全局智能体
-/agents create my-helper --global
-
-# 带自定义描述
-/agents create api-analyzer "分析 API 端点和文档"
-```
-
-**智能体位置：**
-
-- **项目智能体**：`.codely-cli/agents/`（与团队共享）
-- **全局智能体**：`~/.codely-cli/agents/`（个人使用）
-
-### 智能体输出示例
-
-智能体提供结构化的完整结果：
-
-**交互式进度：**
-
-```
-🚀 委派给 codebase_investigator 子智能体...
-🔧 [1] 列出目录 - 扫描项目结构
-✅ 列出目录完成 - 找到 45 个目录
-🤖💭 正在分析 package.json 依赖...
-🔧 [2] 读取文件 - package.json
-✅ 读取文件完成 - 分析依赖中
-📋 结果:
-{
-  "SummaryOfFindings": "React 应用采用三层架构...",
-  "ExplorationTrace": ["分析项目结构", "检查路由"],
-  "RelevantLocations": ["src/components/App.tsx", "src/api/routes.ts"]
-}
-```
-
-## 安装
-
-### 前置要求
-
-确保已安装 [Node.js 20](https://nodejs.org/en/download) 或更高版本。
-
-### 直接安装
-
-```bash
-npm i -g @unity-china/codely-cli
-```
-
-## 快速开始
-
-```bash
-# 启动
-codely
-
-# 示例命令
-> 解释这个代码库结构
-> 帮我重构这个函数
-> 为这个模块生成单元测试
-```
-
-### 会话管理
-
-通过可配置的会话限制控制您的 token 使用量，以优化成本和性能。
-
-#### 配置会话 Token 限制
-
-在您的主目录中创建或编辑 `.codely-cli/settings.json`：
-
-```json
-{
-  "sessionTokenLimit": 32000
-}
-```
-
-#### 会话命令
-
-- **`/compress`** - 压缩对话历史以继续在 token 限制内使用
-- **`/clear`** - 清除所有对话历史并重新开始
-- **`/stats`** - 检查当前 token 使用情况和限制
-
-> 📝 **注意**：会话 token 限制适用于单次对话，而非累计 API 调用。
-
-## 使用示例
-
-### 🔍 探索代码库
-
-```bash
-cd your-project/
-codely
-
-# 架构分析
-> 描述这个系统架构的主要部分
-> 关键依赖是什么，它们如何交互？
-> 查找所有 API 端点及其认证方法
-```
-
-### 💻 代码开发
-
-```bash
-# 重构
-> 重构这个函数以提高可读性和性能
-> 将这个类转换为使用依赖注入
-> 将这个大模块拆分成更小、更专注的组件
-
-# 代码生成
-> 创建一个用户管理的 REST API 端点
-> 为认证模块生成单元测试
-> 为所有数据库操作添加错误处理
-```
-
-### 🔄 自动化工作流
-
-```bash
-# Git 自动化
-> 分析过去 7 天的 git 提交，按功能分组
-> 从最近的提交创建变更日志
-> 查找所有 TODO 注释并创建 GitHub issues
-
-# 文件操作
-> 将此目录中的所有图像转换为 PNG 格式
-> 将所有测试文件重命名为 *.test.ts 模式
-> 查找并删除所有 console.log 语句
-```
-
-### 🐛 调试与分析
-
-```bash
-# 性能分析
-> 识别这个 React 组件中的性能瓶颈
-> 在代码库中查找所有 N+1 查询问题
-
-# 安全审计
-> 检查潜在的 SQL 注入漏洞
-> 查找所有硬编码的凭据或 API 密钥
-```
-
-## 常用任务
-
-### 📚 理解新代码库
-
-```text
-> 核心业务逻辑组件是什么？
-> 有哪些安全机制？
-> 数据如何在系统中流动？
-> 使用了哪些主要设计模式？
-> 为这个模块生成依赖关系图
-```
-
-### 🔨 代码重构与优化
-
-```text
-> 这个模块的哪些部分可以优化？
-> 帮我重构这个类以遵循 SOLID 原则
-> 添加适当的错误处理和日志记录
-> 将回调转换为 async/await 模式
-> 为昂贵的操作实现缓存
-```
-
-### 📝 文档与测试
-
-```text
-> 为所有公共 API 生成全面的 JSDoc 注释
-> 编写包含边界情况的单元测试
-> 以 OpenAPI 格式创建 API 文档
-> 添加解释复杂算法的内联注释
-> 为这个模块生成 README
-```
-
-### 🚀 开发加速
-
-```text
-> 设置一个带认证的新 Express 服务器
-> 创建一个带 TypeScript 和测试的 React 组件
-> 实现一个速率限制中间件
-> 为新架构添加数据库迁移
-> 为这个项目配置 CI/CD 流水线
-```
-
-## 命令与快捷键
-
-### 会话命令
-
-- `/help` - 显示可用命令
-- `/clear` - 清除对话历史
-- `/compress` - 压缩历史以节省 tokens
-- `/stats` - 显示当前会话信息
-- `/exit` 或 `/quit` - 退出 Codely CLI
-
-### MCP 命令
-
-管理模型上下文协议（MCP）服务器以扩展 Codely 的外部工具和服务能力：
-
-- `/mcp` - 列出已配置的 MCP 服务器及其可用工具
-- `/mcp desc` - 显示服务器和工具的详细描述
-- `/mcp schema` - 显示工具参数架构
-- `/mcp auth <server-name>` - 对启用 OAuth 的 MCP 服务器进行身份验证
-- `/mcp refresh` - 刷新 MCP 服务器和工具列表
-
-管理 MCP 服务器配置的 CLI 命令：
-
-#### `codely mcp add <name> <commandOrUrl> [args...]`
-
-添加具有指定名称和连接详情的新 MCP 服务器。
-
-**选项：**
-
-- `--scope` (`-s`) - 配置范围（user 或 project）
-- `--transport` (`-t`) - 传输类型（stdio、sse、http）
-- `--env` (`-e`) - 为 stdio 传输设置环境变量（例如 `-e KEY=value`）
-- `--header` (`-H`) - 为 SSE 和 HTTP 传输设置 HTTP 头（例如 `-H "X-Api-Key: abc123"`）
-- `--timeout` - 连接超时时间（毫秒）
-- `--trust` - 信任服务器（绕过所有工具调用确认提示）
-- `--description` - 服务器描述
-- `--include-tools` - 要包含的工具的逗号分隔列表
-- `--exclude-tools` - 要排除的工具的逗号分隔列表
-
-**传输类型：**
-
-- `stdio`（默认）- 使用指定的命令和参数启动进程
-- `sse` - 使用服务器发送事件协议连接到服务器
-- `http` - 使用 HTTP 协议连接到服务器
-
-**示例：**
-
-```bash
-# 添加 stdio 服务器
-codely mcp add my-server python /path/to/server.py --env API_KEY=abc123
-
-# 添加 HTTP 服务器
-codely mcp add my-http-server http://localhost:8000 --transport http --header "Authorization: Bearer token"
-
-# 添加具有范围配置的服务器
-codely mcp add my-server python /path/to/server.py --scope user
-```
-
-#### `codely mcp list`
-
-列出所有已配置的 MCP 服务器及其连接状态。
-
-#### `codely mcp remove <name>`
-
-删除具有指定名称的 MCP 服务器。
-
-**选项：**
-
-- `--scope` (`-s`) - 配置范围（user 或 project）
-
-### 键盘快捷键
-
-- `Ctrl+C` - 取消当前操作
-- `Ctrl+D` - 退出（在空行上）
-- `上/下箭头` - 浏览命令历史
-
-## 故障排除
-
-如果您遇到问题，请检查错误消息并确保：
-
-- Node.js 版本为 20 或更高
-- 所有依赖项已正确安装
-- API 密钥在设置中正确配置
-
-如需更多帮助，请访问：
-
-- 🌐 [官方网站](https://codely.tuanjie.cn/)
-- 📖 [使用手册](https://yousandi.feishu.cn/wiki/Sqmlw31sYiTm8qkh7s1cSlbenmb)
-
-## 许可证
-
-[LICENSE](./LICENSE)