# Grok-CLI

**Repository Path**: andershsueh/gork-cli

## Basic Information

- **Project Name**: Grok-CLI
- **Description**: 模仿gemini-cli
- **Primary Language**: Python
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-16
- **Last Updated**: 2025-07-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Grok CLI

一个强大的命令行AI助手工具，支持多种AI后端并具备文件操作功能。

## 🌟 项目介绍

Gork CLI是一个灵活的命令行工具，旨在提供统一的AI对话接口。它支持多种AI后端（Ollama和xAI），并集成了智能文件操作功能，让您可以通过自然语言与AI交互并操作本地文件。

## ✨ 主要功能

### 🤖 多AI后端支持
- **Ollama后端**：支持本地运行的开源大语言模型（如Llama 3.1）
- **xAI后端**：支持通过API调用xAI的Grok模型

### 📁 智能文件操作
- **文件读取**：使用`@文件路径`语法快速引用文件内容
- **多媒体支持**：支持读取图片、PDF等多媒体文件（Base64编码）
- **文件替换**：支持通过AI指令修改文件内容

### 🛠️ 工具调用支持
AI可以自动调用以下工具：
- `read_file`：读取指定文件的内容
- `replace_in_file`：替换文件中的特定字符串

## 🚀 快速开始

### 安装依赖

```bash
pip install click ollama openai
```

### 环境配置

1. **Ollama后端**（本地）：
   - 安装并启动Ollama服务
   - 确保模型已下载（如`llama3.1`）

2. **xAI后端**（云端）：
   - 设置环境变量：
   ```bash
   export GROK_API_KEY="your_grok_api_key"
   ```

### 基本使用

```bash
# 直接输入提示词
python cli.py "你好，请介绍一下你自己"

# 交互式模式
python cli.py

# 引用文件内容
python cli.py "请分析这个文件的内容 @config.py"
```

## 📋 详细功能说明

### 命令行参数
- `prompt`（可选）：直接传入AI提示词，如果不提供则进入交互模式

### 文件引用语法
在提示词中使用`@文件路径`可以自动将文件内容包含到对话中：
```bash
python cli.py "优化这段代码 @ai_proxy.py"
```

### 配置文件
`config.py`包含了所有可配置的参数：
- AI后端选择
- 模型配置
- API端点设置
- 上下文长度限制

## 🏗️ 项目结构

```
gork-cli/
├── cli.py              # 命令行入口点
├── ai_proxy.py         # AI后端代理层
├── file_tools.py       # 文件操作工具
├── config.py           # 配置文件
├── __init__.py         # Python包初始化
├── LICENSE             # 木兰宽松许可证v2
└── README.md           # 项目说明文档
```

## 🔧 核心模块

### `cli.py`
命令行接口，使用Click库实现：
- 处理命令行参数
- 提供交互式输入
- 调用AI代理获取响应

### `ai_proxy.py`
AI后端抽象层：
- 统一的AI查询接口
- 支持Ollama和xAI两种后端
- 集成工具调用功能
- 处理文件引用语法

### `file_tools.py`
文件操作工具集：
- `read_file()`：读取文件内容，支持多媒体文件
- `replace_in_file()`：字符串替换功能
- 错误处理和文件验证

### `config.py`
配置管理：
- 后端参数配置
- 模型选择设置
- API密钥管理

## 🎯 使用场景

1. **代码分析**：让AI分析和优化您的代码文件
2. **文档处理**：批量处理和修改文档内容
3. **多媒体分析**：分析图片、PDF等文件内容
4. **自动化脚本**：结合AI能力创建智能脚本
5. **学习助手**：获取编程和技术问题的解答

## 🛡️ 许可证

本项目采用木兰宽松许可证第2版（MulanPSL2）开源协议。

## 🤝 贡献指南

欢迎提交Issue和Pull Request来改进这个项目！

## 📞 联系方式

如有问题或建议，请通过GitHub Issue联系我们。

---

**让AI成为您的命令行伙伴！** 🚀