jarvis-ai-assistant 0.1.12__tar.gz → 0.1.13__tar.gz

{jarvis_ai_assistant-0.1.12 → jarvis_ai_assistant-0.1.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: jarvis-ai-assistant
-Version: 0.1.12
+Version: 0.1.13
 Summary: Jarvis: An AI assistant that uses tools to interact with the system
 Home-page: https://github.com/skyfireitdiy/Jarvis
 Author: skyfire
@@ -72,6 +72,42 @@ Dynamic: requires-python
 - Multi-line input support
 - Colored output with progress indicators
 
+
+## ⚙️ Environment Setup
+
+Before using Jarvis, you need to set up your environment:
+
+1. **API Key Configuration**
+
+Create a `.jarvis_env` file in your home directory (`~/.jarvis_env`):
+
+```bash
+KIMI_API_KEY=your_kimi_api_key_here
+```
+
+To get your Kimi API key:
+1. Visit [Kimi AI Platform](https://kimi.moonshot.cn) in your browser
+2. Login to your account
+3. Open browser Developer Tools (F12 or right-click -> Inspect)
+4. Go to Network tab
+5. Make any request (e.g., send a message)
+6. Find a request to the Kimi API
+7. Look for the `Authorization` header in the request headers
+8. Copy the token value (remove the "Bearer " prefix)
+9. Use this token as your `KIMI_API_KEY` in the `.jarvis_env` file
+
+2. **Task Configuration (Optional)**
+
+Create a `.jarvis` file in your working directory to define predefined tasks:
+
+```yaml
+# .jarvis
+analyze_code: Analyze the code structure and quality in the current directory
+fix_bugs: Help me find and fix potential bugs in the code
+optimize: Suggest optimizations for the code
+document: Generate documentation for the code
+```
+
 ## 🚀 Installation
 
 ```bash
@@ -80,19 +116,44 @@ pip install jarvis-ai-assistant
 
 ## 💡 Usage
 
+1. **Basic Usage**
 ```bash
-# Quick Start
+# Start Jarvis
 jarvis
 
-# Process files
+# Process specific files
 jarvis -f file1.txt file2.py
+```
 
-# Using predefined tasks
-# Create .jarvis file in your working directory:
-analyze_code: Analyze the code in the current directory
-fix_bugs: Help me find and fix bugs in the code
+2. **Using Predefined Tasks**
+
+If you have a `.jarvis` file in your working directory:
+```bash
+# Jarvis will show available tasks on startup
+# Select a task number or start a new conversation
 ```
 
+3. **Interactive Features**
+- Multi-line input support (press Enter twice to submit)
+- File understanding and analysis
+- Context-aware conversations
+- Tool integration for system operations
+
+4. **Environment Variables**
+- `KIMI_API_KEY`: Your Kimi AI API key (required)
+- Location: `~/.jarvis_env`
+- Format: `KEY=value` (one per line)
+
+5. **Task Configuration**
+- File: `.jarvis` in working directory
+- Format: `task_name: task_description`
+- Purpose: Define commonly used tasks for quick access
+- Example tasks:
+  - Code analysis
+  - Bug finding
+  - Documentation generation
+  - Performance optimization
+
 ## 🧰 Tools
 
 | Tool | Description | Example |

{jarvis_ai_assistant-0.1.12 → jarvis_ai_assistant-0.1.13}/README.md

@@ -42,6 +42,42 @@
 - Multi-line input support
 - Colored output with progress indicators
 
+
+## ⚙️ Environment Setup
+
+Before using Jarvis, you need to set up your environment:
+
+1. **API Key Configuration**
+
+Create a `.jarvis_env` file in your home directory (`~/.jarvis_env`):
+
+```bash
+KIMI_API_KEY=your_kimi_api_key_here
+```
+
+To get your Kimi API key:
+1. Visit [Kimi AI Platform](https://kimi.moonshot.cn) in your browser
+2. Login to your account
+3. Open browser Developer Tools (F12 or right-click -> Inspect)
+4. Go to Network tab
+5. Make any request (e.g., send a message)
+6. Find a request to the Kimi API
+7. Look for the `Authorization` header in the request headers
+8. Copy the token value (remove the "Bearer " prefix)
+9. Use this token as your `KIMI_API_KEY` in the `.jarvis_env` file
+
+2. **Task Configuration (Optional)**
+
+Create a `.jarvis` file in your working directory to define predefined tasks:
+
+```yaml
+# .jarvis
+analyze_code: Analyze the code structure and quality in the current directory
+fix_bugs: Help me find and fix potential bugs in the code
+optimize: Suggest optimizations for the code
+document: Generate documentation for the code
+```
+
 ## 🚀 Installation
 
 ```bash
@@ -50,19 +86,44 @@ pip install jarvis-ai-assistant
 
 ## 💡 Usage
 
+1. **Basic Usage**
 ```bash
-# Quick Start
+# Start Jarvis
 jarvis
 
-# Process files
+# Process specific files
 jarvis -f file1.txt file2.py
+```
 
-# Using predefined tasks
-# Create .jarvis file in your working directory:
-analyze_code: Analyze the code in the current directory
-fix_bugs: Help me find and fix bugs in the code
+2. **Using Predefined Tasks**
+
+If you have a `.jarvis` file in your working directory:
+```bash
+# Jarvis will show available tasks on startup
+# Select a task number or start a new conversation
 ```
 
+3. **Interactive Features**
+- Multi-line input support (press Enter twice to submit)
+- File understanding and analysis
+- Context-aware conversations
+- Tool integration for system operations
+
+4. **Environment Variables**
+- `KIMI_API_KEY`: Your Kimi AI API key (required)
+- Location: `~/.jarvis_env`
+- Format: `KEY=value` (one per line)
+
+5. **Task Configuration**
+- File: `.jarvis` in working directory
+- Format: `task_name: task_description`
+- Purpose: Define commonly used tasks for quick access
+- Example tasks:
+  - Code analysis
+  - Bug finding
+  - Documentation generation
+  - Performance optimization
+
 ## 🧰 Tools
 
 | Tool | Description | Example |

{jarvis_ai_assistant-0.1.12 → jarvis_ai_assistant-0.1.13}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "jarvis-ai-assistant"
-version = "0.1.12"
+version = "0.1.13"
 description = "Jarvis: An AI assistant that uses tools to interact with the system"
 readme = "README.md"
 authors = [{ name = "Your Name", email = "your.email@example.com" }]

{jarvis_ai_assistant-0.1.12 → jarvis_ai_assistant-0.1.13}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="jarvis-ai-assistant",
-    version="0.1.12",
+    version="0.1.13",
     author="skyfire",
     author_email="skyfireitdiy@hotmail.com",
     description="An AI assistant that uses various tools to interact with the system",

{jarvis_ai_assistant-0.1.12 → jarvis_ai_assistant-0.1.13}/src/jarvis/__init__.py

@@ -1,3 +1,3 @@
 """Jarvis AI Assistant"""
 
-__version__ = "0.1.12" 
+__version__ = "0.1.13" 

{jarvis_ai_assistant-0.1.12 → jarvis_ai_assistant-0.1.13}/src/jarvis/main.py

@@ -82,7 +82,25 @@ def main():
     try:
         kimi_api_key = os.getenv("KIMI_API_KEY")
         if not kimi_api_key:
-            PrettyOutput.print("Kimi API key 未设置", OutputType.ERROR)
+            PrettyOutput.section("环境配置缺失", OutputType.ERROR)
+            PrettyOutput.print("\n需要设置 KIMI_API_KEY 才能使用 Jarvis。请按以下步骤操作：", OutputType.INFO, timestamp=False)
+            PrettyOutput.print("\n1. 获取 Kimi API Key:", OutputType.INFO, timestamp=False)
+            PrettyOutput.print("   • 访问 Kimi AI 平台: https://kimi.moonshot.cn", OutputType.INFO, timestamp=False)
+            PrettyOutput.print("   • 登录您的账号", OutputType.INFO, timestamp=False)
+            PrettyOutput.print("   • 打开浏览器开发者工具 (F12 或右键 -> 检查)", OutputType.INFO, timestamp=False)
+            PrettyOutput.print("   • 切换到 Network 标签页", OutputType.INFO, timestamp=False)
+            PrettyOutput.print("   • 发送任意消息", OutputType.INFO, timestamp=False)
+            PrettyOutput.print("   • 在请求中找到 Authorization 头部", OutputType.INFO, timestamp=False)
+            PrettyOutput.print("   • 复制 token 值（去掉 'Bearer ' 前缀）", OutputType.INFO, timestamp=False)
+            
+            PrettyOutput.print("\n2. 设置环境变量:", OutputType.INFO, timestamp=False)
+            PrettyOutput.print("   方法 1: 创建或编辑 ~/.jarvis_env 文件:", OutputType.INFO, timestamp=False)
+            PrettyOutput.print("   echo 'KIMI_API_KEY=your_key_here' > ~/.jarvis_env", OutputType.CODE, timestamp=False)
+            
+            PrettyOutput.print("\n   方法 2: 直接设置环境变量:", OutputType.INFO, timestamp=False)
+            PrettyOutput.print("   export KIMI_API_KEY=your_key_here", OutputType.CODE, timestamp=False)
+            
+            PrettyOutput.print("\n设置完成后重新运行 Jarvis。", OutputType.INFO, timestamp=False)
             return 1
         
         model = KimiModel(kimi_api_key)

{jarvis_ai_assistant-0.1.12 → jarvis_ai_assistant-0.1.13}/src/jarvis_ai_assistant.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: jarvis-ai-assistant
-Version: 0.1.12
+Version: 0.1.13
 Summary: Jarvis: An AI assistant that uses tools to interact with the system
 Home-page: https://github.com/skyfireitdiy/Jarvis
 Author: skyfire
@@ -72,6 +72,42 @@ Dynamic: requires-python
 - Multi-line input support
 - Colored output with progress indicators
 
+
+## ⚙️ Environment Setup
+
+Before using Jarvis, you need to set up your environment:
+
+1. **API Key Configuration**
+
+Create a `.jarvis_env` file in your home directory (`~/.jarvis_env`):
+
+```bash
+KIMI_API_KEY=your_kimi_api_key_here
+```
+
+To get your Kimi API key:
+1. Visit [Kimi AI Platform](https://kimi.moonshot.cn) in your browser
+2. Login to your account
+3. Open browser Developer Tools (F12 or right-click -> Inspect)
+4. Go to Network tab
+5. Make any request (e.g., send a message)
+6. Find a request to the Kimi API
+7. Look for the `Authorization` header in the request headers
+8. Copy the token value (remove the "Bearer " prefix)
+9. Use this token as your `KIMI_API_KEY` in the `.jarvis_env` file
+
+2. **Task Configuration (Optional)**
+
+Create a `.jarvis` file in your working directory to define predefined tasks:
+
+```yaml
+# .jarvis
+analyze_code: Analyze the code structure and quality in the current directory
+fix_bugs: Help me find and fix potential bugs in the code
+optimize: Suggest optimizations for the code
+document: Generate documentation for the code
+```
+
 ## 🚀 Installation
 
 ```bash
@@ -80,19 +116,44 @@ pip install jarvis-ai-assistant
 
 ## 💡 Usage
 
+1. **Basic Usage**
 ```bash
-# Quick Start
+# Start Jarvis
 jarvis
 
-# Process files
+# Process specific files
 jarvis -f file1.txt file2.py
+```
 
-# Using predefined tasks
-# Create .jarvis file in your working directory:
-analyze_code: Analyze the code in the current directory
-fix_bugs: Help me find and fix bugs in the code
+2. **Using Predefined Tasks**
+
+If you have a `.jarvis` file in your working directory:
+```bash
+# Jarvis will show available tasks on startup
+# Select a task number or start a new conversation
 ```
 
+3. **Interactive Features**
+- Multi-line input support (press Enter twice to submit)
+- File understanding and analysis
+- Context-aware conversations
+- Tool integration for system operations
+
+4. **Environment Variables**
+- `KIMI_API_KEY`: Your Kimi AI API key (required)
+- Location: `~/.jarvis_env`
+- Format: `KEY=value` (one per line)
+
+5. **Task Configuration**
+- File: `.jarvis` in working directory
+- Format: `task_name: task_description`
+- Purpose: Define commonly used tasks for quick access
+- Example tasks:
+  - Code analysis
+  - Bug finding
+  - Documentation generation
+  - Performance optimization
+
 ## 🧰 Tools
 
 | Tool | Description | Example |