@unity-china/codely-cli 1.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+  Copyright 2025 Google LLC
+  Copyright 2025 Qwen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,332 @@
+# 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)