jarvis-ai-assistant 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

jarvis/jarvis_utils/input.py

@@ -8,99 +8,73 @@
 - 带有模糊匹配的文件路径补全
 - 用于输入控制的自定义键绑定
 """
-from colorama import Fore  # type: ignore
+import os
+from typing import Iterable
+
+from colorama import Fore
 from colorama import Style as ColoramaStyle  # type: ignore
 from fuzzywuzzy import process  # type: ignore
 from prompt_toolkit import PromptSession  # type: ignore
+from prompt_toolkit.completion import CompleteEvent  # type: ignore
 from prompt_toolkit.completion import (
-    CompleteEvent,
     Completer,
-    Completion,  # type: ignore
+    Completion,
     PathCompleter,
-)  # type: ignore
+)
 from prompt_toolkit.document import Document  # type: ignore
 from prompt_toolkit.formatted_text import FormattedText  # type: ignore
+from prompt_toolkit.history import FileHistory  # type: ignore
 from prompt_toolkit.key_binding import KeyBindings  # type: ignore
 from prompt_toolkit.styles import Style as PromptStyle  # type: ignore
 
-from jarvis.jarvis_utils.config import get_replace_map
+from jarvis.jarvis_utils.config import get_data_dir, get_replace_map
 from jarvis.jarvis_utils.output import OutputType, PrettyOutput
 from jarvis.jarvis_utils.tag import ot
 from jarvis.jarvis_utils.utils import copy_to_clipboard
 
+# Sentinel value to indicate that Ctrl+O was pressed
+CTRL_O_SENTINEL = "__CTRL_O_PRESSED__"
+
 
 def get_single_line_input(tip: str) -> str:
     """
     获取支持历史记录的单行输入。
-
-    参数：
-        tip: 要显示的提示信息
-
-    返回：
-        str: 用户的输入
     """
     session: PromptSession = PromptSession(history=None)
-    style = PromptStyle.from_dict(
-        {
-            "prompt": "ansicyan",
-        }
-    )
+    style = PromptStyle.from_dict({"prompt": "ansicyan"})
     return session.prompt(f"{tip}", style=style)
 
 
 class FileCompleter(Completer):
     """
     带有模糊匹配的文件路径自定义补全器。
-
-    属性：
-        path_completer: 基础路径补全器
-        max_suggestions: 显示的最大建议数量
-        min_score: 建议的最小匹配分数
     """
 
     def __init__(self):
-        """使用默认设置初始化文件补全器。"""
         self.path_completer = PathCompleter()
         self.max_suggestions = 10
         self.min_score = 10
         self.replace_map = get_replace_map()
 
-    def get_completions(self, document: Document, _: CompleteEvent) -> Completion:  # type: ignore
-        """
-        生成带有模糊匹配的文件路径补全建议。
-
-        参数：
-            document: 当前正在编辑的文档
-            complete_event: 补全事件
-
-        生成：
-            Completion: 建议的补全项
-        """
+    def get_completions(
+        self, document: Document, _: CompleteEvent
+    ) -> Iterable[Completion]:
         text = document.text_before_cursor
         cursor_pos = document.cursor_position
-        # 查找文本中的所有@位置
         at_positions = [i for i, char in enumerate(text) if char == "@"]
         if not at_positions:
             return
-        # 获取最后一个@位置
         current_at_pos = at_positions[-1]
-        # 如果光标不在最后一个@之后，则不补全
         if cursor_pos <= current_at_pos:
             return
-        # 检查@之后是否有空格
         text_after_at = text[current_at_pos + 1 : cursor_pos]
         if " " in text_after_at:
             return
 
-        # 获取当前@之后的文本
         file_path = text_after_at.strip()
-        # 计算替换长度
         replace_length = len(text_after_at) + 1
 
-        # 获取所有可能的补全项
         all_completions = []
-
-        # 1. 添加特殊标记
         all_completions.extend(
             [(ot(tag), self._get_description(tag)) for tag in self.replace_map.keys()]
         )
@@ -114,7 +88,6 @@ class FileCompleter(Completer):
             ]
         )
 
-        # 2. 添加文件列表
         try:
             import subprocess
 
@@ -135,9 +108,7 @@ class FileCompleter(Completer):
         except Exception:
             pass
 
-        # 统一过滤和排序
         if file_path:
-            # 使用模糊匹配过滤
             scored_items = process.extract(
                 file_path,
                 [item[0] for item in all_completions],
@@ -146,31 +117,25 @@ class FileCompleter(Completer):
             scored_items = [
                 (item[0], item[1]) for item in scored_items if item[1] > self.min_score
             ]
-            # 创建映射以便查找描述
             completion_map = {item[0]: item[1] for item in all_completions}
-            # 生成补全项
             for text, score in scored_items:
-                display_text = text
-                if score < 100:
-                    display_text = f"{text} ({score}%)"
+                display_text = f"{text} ({score}%)" if score < 100 else text
                 yield Completion(
                     text=f"'{text}'",
                     start_position=-replace_length,
                     display=display_text,
                     display_meta=completion_map.get(text, ""),
-                )  # type: ignore
+                )
         else:
-            # 没有输入时返回前max_suggestions个建议
             for text, desc in all_completions[: self.max_suggestions]:
                 yield Completion(
                     text=f"'{text}'",
                     start_position=-replace_length,
                     display=text,
                     display_meta=desc,
-                )  # type: ignore
+                )
 
     def _get_description(self, tag: str) -> str:
-        """获取标记的描述信息"""
         if tag in self.replace_map:
             return (
                 self.replace_map[tag].get("description", tag) + "(Append)"
@@ -181,15 +146,7 @@ class FileCompleter(Completer):
 
 
 def user_confirm(tip: str, default: bool = True) -> bool:
-    """提示用户确认是/否问题
-
-    参数:
-        tip: 显示给用户的消息
-        default: 用户直接回车时的默认响应
-
-    返回:
-        bool: 用户确认返回True，否则返回False
-    """
+    """提示用户确认是/否问题"""
     try:
         suffix = "[Y/n]" if default else "[y/N]"
         ret = get_single_line_input(f"{tip} {suffix}: ")
@@ -198,28 +155,66 @@ def user_confirm(tip: str, default: bool = True) -> bool:
         return False
 
 
-def get_multiline_input(tip: str) -> str:
+def _show_history_and_copy():
     """
-    获取带有增强补全和确认功能的多行输入。
+    Displays message history and handles copying to clipboard.
+    This function uses standard I/O and is safe to call outside a prompt session.
+    """
+    from jarvis.jarvis_utils.globals import get_message_history
+
+    history = get_message_history()
+    if not history:
+        PrettyOutput.print("没有可复制的消息", OutputType.INFO)
+        return
 
-    参数：
-        tip: 要显示的提示信息
+    print("\n" + "=" * 20 + " 消息历史记录 " + "=" * 20)
+    for i, msg in enumerate(history):
+        cleaned_msg = msg.replace("\n", r"\n")
+        display_msg = (cleaned_msg[:70] + "...") if len(cleaned_msg) > 70 else cleaned_msg
+        print(f"  {i + 1}: {display_msg.strip()}")
+    print("=" * 58 + "\n")
 
-    返回：
-        str: 用户的输入，如果取消则返回空字符串
+    while True:
+        try:
+            prompt_text = f"{Fore.CYAN}请输入要复制的条目序号 (或输入c取消, 直接回车选择最后一条): {ColoramaStyle.RESET_ALL}"
+            choice_str = input(prompt_text)
+
+            if not choice_str:  # User pressed Enter
+                if not history:
+                    print("没有历史记录可供选择。")
+                    break
+                choice = len(history) - 1
+            elif choice_str.lower() == "c":
+                print("已取消")
+                break
+            else:
+                choice = int(choice_str) - 1
+
+            if 0 <= choice < len(history):
+                selected_msg = history[choice]
+                copy_to_clipboard(selected_msg)
+                PrettyOutput.print(
+                    f"已复制消息: {selected_msg[:70]}...", OutputType.SUCCESS
+                )
+                break
+            else:
+                print("无效的序号，请重试。")
+        except ValueError:
+            print("无效的输入，请输入数字。")
+        except (KeyboardInterrupt, EOFError):
+            print("\n操作取消")
+            break
+
+
+def _get_multiline_input_internal(tip: str) -> str:
+    """
+    Internal function to get multiline input using prompt_toolkit.
+    Returns a sentinel value if Ctrl+O is pressed.
     """
-    # 显示输入说明
-    PrettyOutput.section(
-        "用户输入 - 使用 @ 触发文件补全，Tab 选择补全项，Ctrl+J 提交，Ctrl+O 复制最后一条消息，按 Ctrl+C 取消输入",
-        OutputType.USER,
-    )
-    print(f"{Fore.GREEN}{tip}{ColoramaStyle.RESET_ALL}")
-    # 配置键绑定
     bindings = KeyBindings()
 
     @bindings.add("enter")
     def _(event):
-        """处理回车键以进行补全或换行。"""
         if event.current_buffer.complete_state:
             event.current_buffer.apply_completion(
                 event.current_buffer.complete_state.current_completion
@@ -229,55 +224,53 @@ def get_multiline_input(tip: str) -> str:
 
     @bindings.add("c-j")
     def _(event):
-        """处理Ctrl+J以提交输入。"""
         event.current_buffer.validate_and_handle()
 
     @bindings.add("c-o")
     def _(event):
-        """处理Ctrl+O以复制最后一条消息到剪贴板。"""
-        from jarvis.jarvis_utils.globals import get_last_message
-
-        last_msg = get_last_message()
-        if last_msg:
-            print(f"{last_msg}")
-            copy_to_clipboard(last_msg)
-        else:
-            PrettyOutput.print("没有可复制的消息", OutputType.INFO)
+        """Handle Ctrl+O by exiting the prompt and returning the sentinel value."""
+        event.app.exit(result=CTRL_O_SENTINEL)
+
+    style = PromptStyle.from_dict({"prompt": "ansicyan"})
+
+    history_dir = get_data_dir()
+    session: PromptSession = PromptSession(
+        history=FileHistory(os.path.join(history_dir, "multiline_input_history")),
+        completer=FileCompleter(),
+        key_bindings=bindings,
+        complete_while_typing=True,
+        multiline=True,
+        vi_mode=False,
+        mouse_support=False,
+    )
 
-        event.app.invalidate()
+    print(f"{Fore.GREEN}{tip}{ColoramaStyle.RESET_ALL}")
+    prompt = FormattedText([("class:prompt", ">>> ")])
 
-    # 配置提示会话
-    style = PromptStyle.from_dict(
-        {
-            "prompt": "ansicyan",
-        }
-    )
     try:
-        import os
-
-        from prompt_toolkit.history import FileHistory  # type: ignore
-
-        from jarvis.jarvis_utils.config import get_data_dir
-
-        # 获取数据目录路径
-        history_dir = get_data_dir()
-        # 初始化带历史记录的会话
-        session: PromptSession = PromptSession(
-            history=FileHistory(os.path.join(history_dir, "multiline_input_history")),
-            completer=FileCompleter(),
-            key_bindings=bindings,
-            complete_while_typing=True,
-            multiline=True,
-            vi_mode=False,
-            mouse_support=False,
-        )
-        prompt = FormattedText([("class:prompt", ">>> ")])
-        # 获取输入
-        text = session.prompt(
-            prompt,
-            style=style,
-        ).strip()
-        return text
-    except KeyboardInterrupt:
-        PrettyOutput.print("输入已取消", OutputType.INFO)
+        return session.prompt(prompt, style=style, pre_run=lambda: None).strip()
+    except (KeyboardInterrupt, EOFError):
         return ""
+
+
+def get_multiline_input(tip: str) -> str:
+    """
+    获取带有增强补全和确认功能的多行输入。
+    此函数处理控制流，允许在不破坏终端状态的情况下处理历史记录复制。
+    """
+    PrettyOutput.section(
+        "用户输入 - 使用 @ 触发文件补全，Tab 选择补全项，Ctrl+J 提交，Ctrl+O 从历史记录中选择消息复制，按 Ctrl+C/D 取消输入",
+        OutputType.USER,
+    )
+
+    while True:
+        user_input = _get_multiline_input_internal(tip)
+
+        if user_input == CTRL_O_SENTINEL:
+            _show_history_and_copy()
+            tip = "请继续输入（或按Ctrl+J提交）:"
+            continue
+        else:
+            if not user_input:
+                PrettyOutput.print("\n输入已取消", OutputType.INFO)
+            return user_input

jarvis/jarvis_utils/output.py

@@ -131,7 +131,7 @@ class PrettyOutput:
         """
         try:
             lexer = guess_lexer(text)
-            detected_lang = lexer.name
+            detected_lang = lexer.name  # type: ignore[attr-defined]
             return PrettyOutput._lang_map.get(detected_lang, default_lang)
         except (ClassNotFound, Exception):
             return default_lang

jarvis/jarvis_utils/utils.py

@@ -445,6 +445,9 @@ def copy_to_clipboard(text: str) -> None:
     参数:
         text: 要复制的文本
     """
+    print("--- 剪贴板内容开始 ---")
+    print(text)
+    print("--- 剪贴板内容结束 ---")
     # 尝试使用 xsel
     try:
         process = subprocess.Popen(

jarvis_ai_assistant-0.2.3.dist-info/METADATA

@@ -0,0 +1,301 @@
+Metadata-Version: 2.4
+Name: jarvis-ai-assistant
+Version: 0.2.3
+Summary: Jarvis: An AI assistant that uses tools to interact with the system
+Home-page: https://github.com/skyfireitdiy/Jarvis
+Author: skyfire
+Author-email: skyfire <skyfireitdiy@hotmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 skyfire
+        
+        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.
+Project-URL: Homepage, https://github.com/skyfireitdiy/Jarvis
+Keywords: jarvis,ai,assistant,tools,automation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9,<3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests==2.32.3
+Requires-Dist: colorama==0.4.6
+Requires-Dist: prompt_toolkit==3.0.50
+Requires-Dist: pygments==2.19.1
+Requires-Dist: fuzzywuzzy==0.18.0
+Requires-Dist: fastapi==0.115.12
+Requires-Dist: uvicorn==0.33.0
+Requires-Dist: rich==14.0.0
+Requires-Dist: python-Levenshtein==0.25.1
+Requires-Dist: tiktoken==0.7.0
+Requires-Dist: pillow==10.2.0
+Requires-Dist: openai==1.78.1
+Requires-Dist: tabulate==0.9.0
+Requires-Dist: pyte==0.8.2
+Requires-Dist: pyyaml>=5.3.1
+Requires-Dist: ddgs==9.0.2
+Requires-Dist: lxml==6.0.0
+Requires-Dist: markdownify>=1.1.0
+Requires-Dist: typer
+Requires-Dist: pathspec
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: rag
+Requires-Dist: langchain; extra == "rag"
+Requires-Dist: langchain-community; extra == "rag"
+Requires-Dist: langchain-huggingface; extra == "rag"
+Requires-Dist: chromadb; extra == "rag"
+Requires-Dist: diskcache; extra == "rag"
+Requires-Dist: sentence-transformers==2.7.0; extra == "rag"
+Requires-Dist: torch>=2.6; extra == "rag"
+Requires-Dist: unstructured[md]; extra == "rag"
+Requires-Dist: rank-bm25; extra == "rag"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# 🤖 Jarvis AI 助手
+<p align="center">
+  <img src="docs/images/jarvis-logo.png" alt="Jarvis Logo" width="200"/>
+</p>
+<div align="center">
+
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+*您的智能开发和系统交互助手*
+
+[快速开始](#quick-start) • [核心功能](#core-features) • [配置说明](#configuration) • [Jarvis Book](#jarvis-book) • [技术细节](docs/technical_documentation.md) • [Wiki文档](docs/jarvis_book/1.项目介绍.md) • [贡献指南](#contributing) • [许可证](#license)
+</div>
+
+---
+
+## 🎯 定位与优势
+
+Jarvis 的定位是**个人开发者的高效助理**，旨在将研发流程中一次性、碎片化的工作变得更加流畅和高效。这与 `workflow` 形式的 `Agent` 平台（如 Dify）有着本质区别，专注于提升个人生产力。
+
+### Jarvis 的核心优势
+
+1.  **访问本地资源**: Jarvis 能够直接与您的本地环境交互，执行诸如**软件开发、代码修复、环境搭建**等需要本地文件系统和工具链的复杂任务。
+2.  **纯粹的命令行体验**: 作为一款纯命令行工具，Jarvis 可以无缝集成到您喜爱的任何IDE、终端或SSH会话中，不干扰您现有的工作流程。
+3.  **Python包形式提供**: Jarvis 以标准的Python包形式分发，可以轻松地作为依赖项集成到您自己构建的AI应用或自动化脚本中。
+
+### 💡 Jarvis 的价值：工作流对比
+
+#### 示例一：开发新功能
+
+**传统工作流 (没有 Jarvis):**
+
+1.  **理解需求**: 阅读需求文档，在代码库中全局搜索，定位可能需要修改的文件和函数。
+2.  **切换上下文**: 在IDE、浏览器（查资料）、终端（执行命令）之间反复切换。
+3.  **编写代码**: 手动编写新功能、单元测试和相关文档。
+4.  **调试**: 反复运行、打印日志、设置断点来定位和修复bug。
+5.  **代码提交**: 手动检查代码变更，撰写符合团队规范的 Git Commit Message。
+> 这个过程不仅耗时，而且频繁的上下文切换极易打断心流，消耗大量精力。
+
+**Jarvis 增强工作流:**
+
+1.  **任务启动**: 在项目根目录，用自然语言向 `jca` (代码助理) 描述需求：`jca "为 'user' 模块增加 'profile' 接口，需要包含用户信息查询和更新功能"`。
+2.  **AI 分析与编码**:
+    *   Jarvis 自动分析代码结构，定位相关文件 (`user/service.py`, `user/controller.py`, `tests/test_user.py`)。
+    *   自动生成新接口的代码、必要的单元测试，并提出修改方案。
+3.  **人机协作与迭代**:
+    *   你审查 AI 生成的代码，并提出修改意见：`"字段名需要用驼峰式"` 或 `"增加一个输入校验"`。
+    *   Jarvis 根据反馈快速迭代，更新代码。
+4.  **自动化提交**:
+    *   完成开发后，执行 `jgc` (Git 提交助理)。
+    *   Jarvis 自动分析代码变更，生成一条规范的 Git Commit Message (例如: `feat(user): add user profile api with query and update`)。
+> 通过 Jarvis，整个流程从“手动执行”变为了“监督和指导”，开发者可以将精力集中在**架构设计和代码审查**等高价值活动上，而不是繁琐的编码和调试细节。
+
+#### 示例二：用 Jarvis 完善本文档
+
+您正在阅读的这部分文档，其诞生过程本身就是 Jarvis 价值的体现。
+
+1.  **初始指令**: `“在README.md中补充jarvis的用户群体和应用场景等信息”`
+2.  **探索与学习**: Jarvis 使用 `fd` 和 `read_code` 工具，分析了 `docs/` 目录下的说明文档，快速学习了项目的核心定位和功能。
+3.  **迭代完善**: 根据 “补充用户群体”、“增加工作流对比”、“再增加一个例子” 等一系列追加指令，Jarvis 通过多次 `PATCH` 操作，逐步、精确地将新内容添加到本文档的指定位置。
+4.  **人机协作**: 在整个过程中，人类提供高层次的目标和方向，Jarvis 负责具体的探索、总结和代码（文档）修改任务，将一个模糊的想法快速落地为结构清晰的文档。
+
+### 👥 目标用户
+
+**谁适合使用 Jarvis？**
+
+*   **个人开发者和极客**: 希望通过AI提升个人开发、学习和探索效率的用户。
+*   **需要处理碎片化任务的工程师**: 面对各种一次性、非标准化的技术任务，例如快速编写脚本、调试代码、搭建新环境等。
+*   **AI应用探索者**: 希望有一个灵活的本地框架来实验和集成不同的大语言模型和工具。
+
+**谁可能不适合？**
+
+*   **寻求固定工作流自动化的人**: 如果您的需求是高度固定和重复的，例如“每天定时抓取数据并生成报告”，那么编写一个专门的、功能单一的脚本可能是更直接、更高效的解决方案。Jarvis 更擅长处理多变和探索性的任务。
+*   **企业级团队协作者**: Jarvis 被设计为个人工具，不包含团队管理、权限控制等面向企业级协作的功能。
+
+总之，Jarvis 是为每一位开发者量身打造的个人助手，而非用于团队协作的集中式平台。
+
+---
+
+## 🚀 快速开始 <a id="quick-start"></a>
+
+### 系统要求
+- **Linux**: 完全支持。
+- **Windows**: 未经充分测试，建议在 [WSL](https://docs.microsoft.com/en-us/windows/wsl/install) 中使用。
+
+### 安装
+
+#### 一键安装 (推荐)
+只需一行命令即可完成所有安装和配置：
+```bash
+bash -c "$(curl -fsSL https://raw.githubusercontent.com/skyfireitdiy/Jarvis/main/scripts/install.sh)"
+```
+> 该脚本会自动检测Python环境、克隆项目、安装依赖并设置好路径。
+
+#### 手动安装
+```bash
+git clone https://github.com/skyfireitdiy/Jarvis
+cd Jarvis
+pip3 install -e .
+```
+或者从PyPI安装 (可能不是最新版):
+```bash
+pip3 install jarvis-ai-assistant
+```
+
+### 基本使用
+Jarvis 包含一系列专注于不同任务的工具。以下是主要命令及其快捷方式：
+
+| 命令 | 快捷方式 | 功能描述 |
+|------|----------|----------|
+| `jarvis` | `jvs` | 通用AI代理，适用于多种任务 |
+| `jarvis-code-agent` | `jca` | 专注于代码分析、修改和生成的代码代理 |
+| `jarvis-git-commit` | `jgc` | 自动化分析代码变更并生成规范的Git提交信息 |
+| `jarvis-platform-manager` | `jpm` | 管理和测试不同的大语言模型平台 |
+| `jarvis-rag` | `jrg` | 构建和查询本地化的RAG知识库 |
+| `jarvis-smart-shell` | `jss` | 实验性的智能Shell功能 |
+
+更多详细用法和参数，请查阅我们的 [**使用指南**](docs/jarvis_book/4.使用指南.md)。
+
+---
+
+## 🌟 核心功能 <a id="core-features"></a>
+
+- **🆓 零成本接入**: 无缝集成腾讯元宝、Kimi等优质模型，无需支付API费用。
+- **🛠️ 工具驱动**: 内置丰富工具集，涵盖脚本执行、代码开发、网页搜索、终端操作等。
+- **🤖 人机协作**: 支持实时交互，用户可随时介入指导，确保AI行为符合预期。
+- **🔌 高度可扩展**: 支持自定义工具、模型平台和MCP，轻松打造个性化工作流。
+- **🧠 RAG 增强**: 内置RAG功能，可将本地文档作为知识库，实现精准问答。
+
+### 视频演示
+- [使用`jca`为Jarvis快速扩展功能](https://www.bilibili.com/video/BV1TCgLzvE6Q/)
+- [10分钟搭建aarch64容器化Rust开发环境](https://www.bilibili.com/video/BV1K3ghzkEzZ/)
+- [`jarvis-code-agent` 功能演示](https://www.bilibili.com/video/BV1KugbzKE6U/)
+
+---
+
+## ⚙️ 配置说明 <a id="configuration"></a>
+
+Jarvis 的主要配置文件位于 `~/.jarvis/config.yaml`。您可以在此文件中配置模型、平台和其他行为。
+
+**基本配置示例 (腾讯元宝):**
+```yaml
+# ~/.jarvis/config.yaml
+
+# 使用的模型平台
+JARVIS_PLATFORM: yuanbao
+JARVIS_MODEL: deep_seek_v3
+
+# 用于“思考”步骤的模型，通常选择能力更强的模型
+JARVIS_THINKING_PLATFORM: yuanbao
+JARVIS_THINKING_MODEL: deep_seek
+
+# 平台所需的环境变量
+ENV:
+  YUANBAO_COOKIES: "在此处粘贴您的元宝Cookies"
+```
+
+Jarvis 支持多种平台，包括 **Kimi**, **通义千问**, **OpenAI** 等。详细的配置选项、模型组设置以及所有可用参数，请参阅 [**使用指南**](docs/jarvis_book/4.使用指南.md)。
+
+> **模型推荐**: 目前效果最好的模型是 `gemini-1.5-pro`，可以通过国内代理商购买，例如 [FoxiAI](https://foxi-ai.top)。
+
+---
+
+## 🛠️ 扩展开发 <a id="extensions"></a>
+
+Jarvis 被设计为高度可扩展的框架。您可以轻松地：
+- **添加新工具**: 在 `~/.jarvis/tools/` 目录下创建新的工具实现。
+- **集成新LLM平台**: 在 `~/.jarvis/platforms/` 目录下添加新的平台适配器。
+- **定义MCP**: 通过配置文件集成外部或自定义的命令协议。
+
+有关扩展开发的详细指南和[**技术细节**](docs/technical_documentation.md)，请访问我们的 [**开发者文档**](docs/jarvis_book/5.功能扩展.md)。
+
+---
+
+## 📖 Jarvis Book <a id="jarvis-book"></a>
+
+欢迎阅读 Jarvis 的官方文档，这本开源书籍旨在为您提供从入门到精通的全方位指南。
+
+- **[第一章：项目介绍](docs/jarvis_book/1.项目介绍.md)**
+- **[第二章：快速开始](docs/jarvis_book/2.快速开始.md)**
+- **[第三章：核心概念与架构](docs/jarvis_book/3.核心概念与架构.md)**
+- **[第四章：使用指南](docs/jarvis_book/4.使用指南.md)**
+- **[第五章：功能扩展](docs/jarvis_book/5.功能扩展.md)**
+- **[第六章：高级主题](docs/jarvis_book/6.高级主题.md)**
+- **[第七章：参与贡献](docs/jarvis_book/7.参与贡献.md)**
+- **[第八章：常见问题](docs/jarvis_book/8.常见问题.md)**
+- **[第九章：附录](docs/jarvis_book/9.附录.md)**
+
+---
+
+## 🤝 贡献指南 <a id="contributing"></a>
+
+我们欢迎任何形式的贡献！
+1. Fork 本仓库
+2. 创建您的特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交您的更改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 开启一个 Pull Request
+
+---
+
+## ⚠️ 免责声明 <a id="disclaimer"></a>
+
+- **模型使用风险**: 频繁使用通过非官方API（如腾讯元宝、Kimi、通义千问等）接入的模型可能会导致您的账户被平台封禁。请合理使用，并自行承担相应风险。
+- **命令执行风险**: Jarvis具备执行系统命令的能力。请确保您了解将要执行的命令，并避免输入可能导致系统风险的指令。为了增强安全性，您可以在配置文件中启用工具执行确认（`JARVIS_EXECUTE_TOOL_CONFIRM: true`），以便在执行每个工具前进行手动确认。
+
+---
+
+## 📄 许可证 <a id="license"></a>
+
+本项目采用 MIT 许可证 - 详见 [LICENSE](LICENSE) 文件。
+
+---
+<div align="center">
+由 Jarvis 团队用 ❤️ 制作
+</div>
+
+![Jarvis技术支持群](docs/images/wechat.png)