@mimocode/cli 3.0.2

package/LICENSE

@@ -0,0 +1,401 @@
+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 [yyyy] [name of copyright owner]
+
+   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.
+</content>
+<write_to_file>
+<path>jwcode/PROJECT_SUMMARY.md</path>
+<content># JWCode 项目总结
+
+## 项目概述
+
+JWCode 是一个用 Java 重构的终端 AI 编码工具，完全参照 Claude Code 的并行设计。本项目旨在提供一个功能完整、架构清晰的 Java 实现，便于学习和扩展。
+
+## 已完成的工作
+
+### 1. 项目文档
+
+- ✅ README.md - 项目介绍和快速开始指南
+- ✅ docs/developer-guide.md - 开发者文档，包含架构设计、代码规范等
+- ✅ PROJECT_SUMMARY.md - 项目总结文档（本文件）
+- ✅ LICENSE - Apache 2.0 许可证
+
+### 2. Maven 项目结构
+
+```
+jwcode/
+├── pom.xml                    # 根 POM
+├── jwcode-parent/             # 父 POM（依赖管理）
+│   └── pom.xml
+├── jwcode-common/             # 公共工具模块
+│   └── pom.xml
+├── jwcode-core/               # 核心引擎模块
+│   └── pom.xml
+├── jwcode-cli/                # CLI 模块
+│   └── pom.xml
+├── jwcode-repl/               # REPL 引擎模块
+│   └── pom.xml
+├── jwcode-sdk/                # SDK 桥接模块
+│   └── pom.xml
+├── jwcode-mcp/                # MCP 服务模块
+│   └── pom.xml
+├── jwcode-plugin/             # 插件系统模块
+│   └── pom.xml
+├── jwcode-skill/              # 技能系统模块
+│   └── pom.xml
+├── jwcode-lsp/                # LSP 服务模块
+│   └── pom.xml
+├── jwcode-analytics/          # 分析服务模块
+│   └── pom.xml
+└── jwcode-distribution/       # 分发打包模块
+    └── pom.xml
+```
+
+### 3. 核心代码实现
+
+#### jwcode-common 模块
+- ✅ `Preconditions.java` - 参数校验工具类
+
+#### jwcode-core 模块
+- ✅ `Tool.java` - 工具接口
+- ✅ `ToolResult.java` - 工具执行结果类
+- ✅ `ToolProgress.java` - 工具进度类
+- ✅ `ToolContext.java` - 工具执行上下文类
+- ✅ `CanUseToolFn.java` - 权限检查函数接口
+- ✅ `ToolRegistry.java` - 工具注册表类
+- ✅ `Message.java` - 消息模型类
+
+#### jwcode-cli 模块
+- ✅ `JwCodeApplication.java` - CLI 应用程序入口类
+
+### 4. 配置文件
+
+- ✅ `config.example.json` - 配置文件示例
+
+## 架构设计
+
+### 分层架构
+
+```
+┌─────────────────────────────────────────────────────────┐
+│                    Application Layer                     │
+│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐      │
+│  │   CLI       │  │   REPL      │  │   SDK       │      │
+│  └──────┬──────┘  └──────┬──────┘  └──────┬──────┘      │
+├─────────────────────────────────────────────────────────┤
+│                      Core Layer                          │
+│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐      │
+│  │  Query      │  │   Tool      │  │  Session    │      │
+│  │  Engine     │  │  Executor   │  │  Manager    │      │
+│  └─────────────┘  └─────────────┘  └─────────────┘      │
+├─────────────────────────────────────────────────────────┤
+│                    Services Layer                        │
+│  ┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐           │
+│  │  MCP   │ │ Plugin │ │ Skill  │ │  LSP   │           │
+│  └────────┘ └────────┘ └────────┘ └────────┘           │
+├─────────────────────────────────────────────────────────┤
+│                 Infrastructure Layer                     │
+│  ┌──────────┐ ┌──────────┐ ┌──────────┐                │
+│  │   File   │ │  Process │ │  Network │                │
+│  └──────────┘ └──────────┘ └──────────┘                │
+└─────────────────────────────────────────────────────────┘
+```
+
+### 核心模块职责
+
+| 模块 | 职责 |
+|------|------|
+| jwcode-core | 查询引擎、工具系统、会话管理 |
+| jwcode-cli | 命令行解析、命令路由 |
+| jwcode-repl | 交互式终端界面 |
+| jwcode-mcp | MCP 协议支持 |
+| jwcode-plugin | 插件生命周期管理 |
+| jwcode-skill | 技能系统 |
+
+## 下一步工作
+
+### 待实现的功能
+
+1. **核心引擎**
+   - [ ] QueryEngine 实现
+   - [ ] ToolExecutor 实现
+   - [ ] SessionManager 实现
+   - [ ] ApiClient 实现
+
+2. **内置工具**
+   - [ ] BashTool - 执行 shell 命令
+   - [ ] ReadTool - 读取文件
+   - [ ] EditTool - 编辑文件
+   - [ ] WriteTool - 写入文件
+   - [ ] GrepTool - 文本搜索
+   - [ ] GlobTool - 文件匹配
+
+3. **UI/UX**
+   - [ ] REPL 输入处理
+   - [ ] 终端渲染
+   - [ ] 进度显示
+   - [ ] 错误处理
+
+4. **扩展系统**
+   - [ ] MCP 客户端完整实现
+   - [ ] 插件加载器
+   - [ ] 技能执行引擎
+
+5. **测试**
+   - [ ] 单元测试
+   - [ ] 集成测试
+   - [ ] 端到端测试
+
+## 技术栈
+
+- **Java 版本**: 17+
+- **构建工具**: Maven 3.8+
+- **主要依赖**:
+  - Jackson (JSON 处理)
+  - OkHttp (HTTP 客户端)
+  - Picocli (命令行解析)
+  - JLine (终端 UI)
+  - Reactor (响应式编程)
+  - SLF4J + Logback (日志)
+
+## 开发指南
+
+### 构建项目
+
+```bash
+cd jwcode
+mvn clean install
+```
+
+### 运行项目
+
+```bash
+# 交互模式
+java -jar jwcode-cli/target/jwcode-cli-1.0.0.jar
+
+# 非交互模式
+java -jar jwcode-cli/target/jwcode-cli-1.0.0.jar -p "你好"
+```
+
+### 添加新工具
+
+1. 实现 `Tool` 接口
+2. 在 `ToolRegistry.createDefault()` 中注册
+3. 编写单元测试
+
+## 参考资源
+
+- [原始项目 (Claude Code)](https://github.com/anthropics/claude-code)
+- [Java 官方文档](https://docs.oracle.com/en/java/)
+- [Maven 官方文档](https://maven.apache.org/guides/)
+
+## 贡献指南
+
+欢迎贡献代码、报告问题或提出建议！
+
+1. Fork 项目
+2. 创建特性分支
+3. 提交更改
+4. 推送到分支
+5. 开启 Pull Request
+
+---
+
+**JWCode Team** - 2024