@zyzheal/ola-cc 0.1.2 → 0.2.1

package/README.md

@@ -1,26 +1,29 @@
-# Ola-CC (Ola Claude Code)
+# Claude Code
 
 AI 编码助手，运行在你的终端中。
 
 ## 安装
 
 ```bash
-npm install -g @zyzheal/ola-cc
+npm install claude
+# 或
+bun add claude
 ```
 
 ## 使用
 
 ```bash
 # 启动交互式会话
-ola-cc
+npx claude
 
-# 或使用 npx
-npx @zyzheal/ola-cc
+# 或全局安装
+npm install -g claude
+claude
 ```
 
 ## 配置文件
 
-Ola-CC 的配置存储在 `~/.claude/` 目录中。
+Claude Code 的配置存储在 `~/.claude/` 目录中。
 
 ### 配置目录结构
 
@@ -92,6 +95,59 @@ Ola-CC 的配置存储在 `~/.claude/` 目录中。
 - **name** — 模型名称，格式取决于代理服务的 API。本地 Ollama 代理通常为 `qwen/qwen3-235b-a22b` 或 `llama3.1`
 - **provider** — 提供商类型，本地 OpenAI 兼容代理填 `openai`，也支持 `bedrock`、`vertex` 等
 
+#### OpenAI 协议支持
+
+当设置 `OPENAI_BASE_URL` 或 `OPENAI_API_KEY` 时，CLI 会自动使用 OpenAI 兼容协议与 API 通信。
+
+**必填环境变量：**
+
+| 环境变量 | 说明 |
+|----------|------|
+| `OPENAI_API_KEY` | API 密钥（必填） |
+| `OPENAI_BASE_URL` | API 基础 URL（必填） |
+| `OPENAI_MODEL` | 模型名称（推荐，作为 `settings.json` 中 `model` 字段的默认值） |
+
+**支持的端点示例：**
+
+| 服务 | OPENAI_BASE_URL | 说明 |
+|------|----------------|------|
+| 阿里云百炼 DashScope | `https://coding.dashscope.aliyuncs.com/v1` | 支持通义千问系列模型 |
+| OpenAI 官方 API | `https://api.openai.com/v1` | GPT-4o、o1 等 |
+| Ollama (本地) | `http://127.0.0.1:11434/v1` | 本地部署的开源模型 |
+| vLLM | `http://localhost:8000/v1` | 兼容 OpenAI API 格式的推理服务 |
+
+**使用方式：**
+
+```bash
+# 命令行直接传入
+OPENAI_BASE_URL="https://coding.dashscope.aliyuncs.com/v1" \
+OPENAI_API_KEY="your-api-key" \
+OPENAI_MODEL="qwen3.6-plus" \
+claude
+
+# 或在 ~/.claude/session.json 中配置
+{
+  "env": {
+    "OPENAI_BASE_URL": "https://coding.dashscope.aliyuncs.com/v1",
+    "OPENAI_API_KEY": "your-api-key",
+    "OPENAI_MODEL": "qwen3.6-plus"
+  }
+}
+```
+
+**模型选择优先级：**
+
+1. `/model` 命令（会话中动态切换）
+2. `--model` 启动参数
+3. `ANTHROPIC_MODEL` 环境变量
+4. `OPENAI_MODEL` 环境变量
+5. `~/.claude/settings.json` 中的 `model` 字段
+6. 内置默认值
+
+**注意事项：**
+- 推荐设置 `OPENAI_MODEL` 环境变量，它会作为模型选择的主要来源之一
+- 支持流式和非流式响应
+
 ### settings.json 配置示例
 
 ```json
@@ -133,6 +189,9 @@ Ola-CC 的配置存储在 `~/.claude/` 目录中。
 | 变量 | 说明 |
 |------|------|
 | `ANTHROPIC_API_KEY` | API 密钥 |
+| `CLAUDE_CODE_USE_OPENAI` | 启用 OpenAI 协议（1=启用） |
+| `OPENAI_API_KEY` | OpenAI API 密钥 |
+| `OPENAI_API_BASE` | OpenAI 兼容 API 基础 URL |
 | `CLAUDE_CODE_ENABLE_CFC` | 启用 Chrome 集成（1=启用，0=禁用） |
 | `CLAUDE_CHROME_HTTP` | 启用 Chrome HTTP 桥接模式（1=启用） |
 | `CLAUDE_CHROME_HTTP_PORT` | HTTP 服务器端口（默认 12306） |
@@ -141,7 +200,7 @@ Ola-CC 的配置存储在 `~/.claude/` 目录中。
 
 ## 开启"宠物"功能
 
-"宠物"（SprocketDudot）是 Ola-CC 的伴随功能。开启方式：
+"宠物"（SprocketDudot）是 Claude Code 的伴随功能。开启方式：
 
 1. **通过 session.json 配置**：
 
@@ -157,11 +216,11 @@ Ola-CC 的配置存储在 `~/.claude/` 目录中。
 
 2. **通过环境变量**：
 
-   在启动 Ola-CC 前设置环境变量：
+   在启动 Claude Code 前设置环境变量：
 
    ```bash
    export SPROCKET_DUDOT_ENABLED=1
-   ola-cc
+   claude
    ```
 
 3. **通过 settings.json 配置**：
@@ -180,7 +239,7 @@ Ola-CC 的配置存储在 `~/.claude/` 目录中。
 
 浏览器自动化需要安装 Claude in Chrome 扩展：
 
-1. Ola-CC 会自动安装原生主机清单
+1. Claude Code 会自动安装原生主机清单
 2. 从 Chrome 应用商店安装扩展
 3. 设置 `CLAUDE_CODE_ENABLE_CFC=1` 或使用 `--chrome` 参数