252 lines
6.2 KiB
Markdown
252 lines
6.2 KiB
Markdown
# XCodeCLI-Shells
|
|
|
|
> Claude Code 与 XCodeCLI API 路由器集成的配置脚本
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
|
[](https://github.com/your-username/XCodeCLI-Shells)
|
|
|
|
## 项目简介
|
|
|
|
XCodeCLI-Shells 是一个跨平台的配置工具集，用于设置 Claude Code 与 XCodeCLI API 路由器的集成。通过这些脚本，您可以轻松配置 Claude Code 使用自定义的 API 端点，支持个人和团队 API 访问。
|
|
|
|
## 功能特性
|
|
|
|
- 🌐 **跨平台支持**: 支持 Windows (PowerShell) 和 Unix/Linux/macOS (Bash)
|
|
- 🔐 **安全验证**: API 密钥格式验证和连接测试
|
|
- ⚡ **快速配置**: 自动生成 Claude Code 配置文件和环境变量
|
|
- 🛡️ **数据保护**: 自动备份现有配置，敏感信息掩码显示
|
|
- 🎯 **智能端点选择**: 自动测试多个 API 端点，选择最佳可用服务
|
|
- 📊 **实时反馈**: 彩色输出和详细的状态信息
|
|
- 🚀 **一键安装**: 支持从远程直接下载执行，无需本地文件
|
|
|
|
## 快速开始
|
|
|
|
### 🚀 一行命令快速配置
|
|
|
|
> **注意**: 请将 `YOUR_API_KEY` 替换为您的实际 API 密钥。脚本会自动测试 `https://api.xcodecli.com` 和 `https://api2.xcodecli.com`，选择可用的端点。
|
|
|
|
#### Windows (PowerShell)
|
|
|
|
```powershell
|
|
$key='YOUR_API_KEY'
|
|
iwr -useb https://gitea.sususu.cf/sususu/xcodecli-shells/raw/branch/main/setup-claude-code.ps1 | iex
|
|
```
|
|
|
|
#### Unix/Linux/macOS (Bash)
|
|
|
|
```bash
|
|
export API_KEY='YOUR_API_KEY'
|
|
curl -fsSL https://gitea.sususu.cf/sususu/xcodecli-shells/raw/branch/main/setup-claude-code.sh | bash
|
|
```
|
|
|
|
### 环境要求
|
|
|
|
#### Windows
|
|
|
|
- PowerShell 5.0 或更高版本
|
|
- 网络连接
|
|
|
|
#### Unix/Linux/macOS
|
|
|
|
- Bash shell
|
|
- `jq` 命令行工具
|
|
- `curl` 工具
|
|
|
|
### 安装 jq (仅 Unix/Linux/macOS)
|
|
|
|
```bash
|
|
# macOS (使用 Homebrew)
|
|
brew install jq
|
|
|
|
# Ubuntu/Debian
|
|
sudo apt-get install jq
|
|
|
|
# CentOS/RHEL/Fedora
|
|
sudo yum install jq
|
|
# 或者 (较新版本)
|
|
sudo dnf install jq
|
|
```
|
|
|
|
## 使用方法
|
|
|
|
### Windows (PowerShell)
|
|
|
|
#### 基本使用
|
|
|
|
```powershell
|
|
.\setup-claude-code.ps1 -ApiKey your-api-key-here
|
|
```
|
|
|
|
#### 交互模式
|
|
|
|
```powershell
|
|
.\setup-claude-code.ps1
|
|
```
|
|
|
|
#### 测试连接
|
|
|
|
```powershell
|
|
.\setup-claude-code.ps1 -Test -ApiKey your-api-key-here
|
|
```
|
|
|
|
#### 显示当前设置
|
|
|
|
```powershell
|
|
.\setup-claude-code.ps1 -Show
|
|
```
|
|
|
|
#### 帮助信息
|
|
|
|
```powershell
|
|
.\setup-claude-code.ps1 -Help
|
|
```
|
|
|
|
> **智能端点选择**: 脚本会自动测试多个 API 端点并选择可用的那个，无需手动指定 URL。
|
|
|
|
### Unix/Linux/macOS (Bash)
|
|
|
|
#### 基本使用
|
|
|
|
```bash
|
|
./setup-claude-code.sh --key your-api-key-here
|
|
```
|
|
|
|
#### 交互模式
|
|
|
|
```bash
|
|
./setup-claude-code.sh
|
|
```
|
|
|
|
#### 测试连接
|
|
|
|
```bash
|
|
./setup-claude-code.sh --test --key your-api-key-here
|
|
```
|
|
|
|
#### 显示当前设置
|
|
|
|
```bash
|
|
./setup-claude-code.sh --show
|
|
```
|
|
|
|
#### 帮助信息
|
|
|
|
```bash
|
|
./setup-claude-code.sh --help
|
|
```
|
|
|
|
> **智能端点选择**: 脚本会自动测试多个 API 端点并选择可用的那个，无需手动指定 URL。
|
|
|
|
## 参数说明
|
|
|
|
### PowerShell 脚本参数
|
|
|
|
| 参数 | 类型 | 描述 |
|
|
| --------- | ------ | ----------------------------------------- |
|
|
| `-ApiKey` | String | API 密钥 |
|
|
| `-Test` | Switch | 仅测试 API 连接（会自动测试所有可用端点） |
|
|
| `-Show` | Switch | 显示当前设置 |
|
|
| `-Help` | Switch | 显示帮助信息 |
|
|
|
|
> **自动端点发现**: 脚本会自动测试以下端点并选择第一个可用的：
|
|
>
|
|
> - `https://api.xcodecli.com`
|
|
> - `https://api2.xcodecli.com`
|
|
|
|
### Bash 脚本参数
|
|
|
|
| 参数 | 类型 | 描述 |
|
|
| ------------ | ------ | ----------------------------------------- |
|
|
| `-k, --key` | String | API 密钥 |
|
|
| `-t, --test` | Flag | 仅测试 API 连接（会自动测试所有可用端点） |
|
|
| `-s, --show` | Flag | 显示当前设置 |
|
|
| `-h, --help` | Flag | 显示帮助信息 |
|
|
|
|
> **环境变量支持**: 脚本也支持通过 `API_KEY` 环境变量传递 API 密钥。
|
|
|
|
## 配置文件
|
|
|
|
脚本会在以下位置创建配置文件：
|
|
|
|
- **Windows**: `%USERPROFILE%\.claude\settings.json`
|
|
- **Unix/Linux/macOS**: `~/.claude/settings.json`
|
|
|
|
### 配置文件结构
|
|
|
|
```json
|
|
{
|
|
"env": {
|
|
"ANTHROPIC_BASE_URL": "https://api.xcodecli.com",
|
|
"ANTHROPIC_AUTH_TOKEN": "your-api-key",
|
|
"CLAUDE_CODE_MAX_OUTPUT_TOKENS": 20000,
|
|
"DISABLE_TELEMETRY": 1,
|
|
"DISABLE_ERROR_REPORTING": 1,
|
|
"CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": 1,
|
|
"CLAUDE_BASH_MAINTAIN_PROJECT_WORKING_DIR": 1,
|
|
"MAX_THINKING_TOKENS": 12000
|
|
},
|
|
"model": "sonnet"
|
|
}
|
|
```
|
|
|
|
## 安全特性
|
|
|
|
- **API 密钥验证**: 只接受包含字母数字、连字符和下划线的密钥格式
|
|
- **配置备份**: 自动备份现有配置文件（带时间戳）
|
|
- **敏感信息保护**: 在输出中自动掩码显示 API 密钥
|
|
- **连接验证**: 配置前测试 API 连接有效性
|
|
|
|
## 故障排除
|
|
|
|
### Windows PowerShell 执行策略错误
|
|
|
|
如果遇到执行策略错误，请使用以下命令：
|
|
|
|
```powershell
|
|
powershell -ExecutionPolicy Bypass -File setup-claude-code.ps1
|
|
```
|
|
|
|
### Unix/Linux/macOS 权限问题
|
|
|
|
确保脚本具有执行权限：
|
|
|
|
```bash
|
|
chmod +x setup-claude-code.sh
|
|
```
|
|
|
|
### jq 未安装错误
|
|
|
|
请按照[环境要求](#环境要求)部分安装 `jq` 工具。
|
|
|
|
### API 连接失败
|
|
|
|
1. 检查网络连接
|
|
2. 验证 API URL 是否正确
|
|
3. 确认 API 密钥有效性
|
|
4. 检查防火墙设置
|
|
|
|
## 验证安装
|
|
|
|
安装完成后，您可以使用以下命令验证 Claude Code 配置：
|
|
|
|
```bash
|
|
claude --version
|
|
```
|
|
|
|
## 贡献
|
|
|
|
欢迎提交 Issues 和 Pull Requests 来改进这个项目。
|
|
|
|
## 许可证
|
|
|
|
本项目采用 MIT 许可证。详情请参阅 [LICENSE](LICENSE) 文件。
|
|
|
|
## 相关链接
|
|
|
|
- [Claude Code 官方文档](https://docs.claude.com/en/docs/claude-code)
|
|
- [XCodeCLI 项目](https://api.xcodecli.com)
|
|
|
|
---
|
|
|
|
**注意**: 请确保您的 API 密钥安全，不要在公共代码库中提交包含真实 API 密钥的配置文件。
|