chuan/CLIProxyAPI
1
0
Fork 0
mirror of https://github.com/router-for-me/CLIProxyAPI.git synced 2026-02-19 12:50:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README documentation to clarify auth-dir configuration for Windows users

Browse Source 
- Added a note for setting `auth-dir` on Windows systems in both English and Chinese README files.
- Improved descriptions for existing configuration options.
This commit is contained in:
Luis Pater
2025-08-29 09:52:10 +08:00
parent 09b9d3b3fa
commit c2b2c9eafe
2 changed files with 46 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -240,9 +240,9 @@ The server uses a YAML configuration file (`config.yaml`) located in the project
### Configuration Options ### Configuration Options
| Parameter | Type | Default | Description | | Parameter | Type | Default | Description |
|-----------------------------------------|----------|--------------------|---------------------------------------------------------------------------------------------------------| |-----------------------------------------|----------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `port` | integer | 8317 | The port number on which the server will listen. | | `port` | integer | 8317 | The port number on which the server will listen. |
| `auth-dir` | string | "~/.cli-proxy-api" | Directory where authentication tokens are stored. Supports using `~` for the home directory. | | `auth-dir` | string | "~/.cli-proxy-api" | Directory where authentication tokens are stored. Supports using `~` for the home directory. If you use Windows, please set the directory like this: `C:/cli-proxy-api/` |
| `proxy-url` | string | "" | Proxy URL. Supports socks5/http/https protocols. Example: socks5://user:pass@192.168.1.1:1080/ | | `proxy-url` | string | "" | Proxy URL. Supports socks5/http/https protocols. Example: socks5://user:pass@192.168.1.1:1080/ |
| `request-retry` | integer | 0 | Number of times to retry a request. Retries will occur if the HTTP response code is 403, 408, 500, 502, 503, or 504. | | `request-retry` | integer | 0 | Number of times to retry a request. Retries will occur if the HTTP response code is 403, 408, 500, 502, 503, or 504. |
| `quota-exceeded` | object | {} | Configuration for handling quota exceeded. | | `quota-exceeded` | object | {} | Configuration for handling quota exceeded. |
@@ -268,7 +268,7 @@ The server uses a YAML configuration file (`config.yaml`) located in the project
# Server port # Server port
port: 8317 port: 8317
# Authentication directory (supports ~ for home directory) # Authentication directory (supports ~ for home directory). If you use Windows, please set the directory like this: `C:/cli-proxy-api/`
auth-dir: "~/.cli-proxy-api" auth-dir: "~/.cli-proxy-api"
# Enable debug logging # Enable debug logging

6
README_CN.md
View File

@@ -239,9 +239,9 @@ console.log(await claudeResponse.json());
### 配置选项 ### 配置选项
| 参数 | 类型 | 默认值 | 描述 | | 参数 | 类型 | 默认值 | 描述 |
|---------------------------------------|----------|--------------------|---------------------------------------------------------------------------------------------| |-----------------------------------------|----------|--------------------|---------------------------------------------------------------------|
| `port` | integer | 8317 | 服务器将监听的端口号。 | | `port` | integer | 8317 | 服务器将监听的端口号。 |
| `auth-dir` | string | "~/.cli-proxy-api" | 存储身份验证令牌的目录。支持使用 `~` 来表示主目录。 | | `auth-dir` | string | "~/.cli-proxy-api" | 存储身份验证令牌的目录。支持使用 `~` 来表示主目录。如果你使用Windows，建议设置成`C:/cli-proxy-api/`。 |
| `proxy-url` | string | "" | 代理URL。支持socks5/http/https协议。例如：socks5://user:pass@192.168.1.1:1080/ | | `proxy-url` | string | "" | 代理URL。支持socks5/http/https协议。例如：socks5://user:pass@192.168.1.1:1080/ |
| `request-retry` | integer | 0 | 请求重试次数。如果HTTP响应码为403、408、500、502、503或504，将会触发重试。 | | `request-retry` | integer | 0 | 请求重试次数。如果HTTP响应码为403、408、500、502、503或504，将会触发重试。 |
| `quota-exceeded` | object | {} | 用于处理配额超限的配置。 | | `quota-exceeded` | object | {} | 用于处理配额超限的配置。 |
@@ -267,7 +267,7 @@ console.log(await claudeResponse.json());
# 服务器端口 # 服务器端口
port: 8317 port: 8317
# 身份验证目录（支持 ~ 表示主目录） # 身份验证目录（支持 ~ 表示主目录）。如果你使用Windows，建议设置成`C:/cli-proxy-api/`。
auth-dir: "~/.cli-proxy-api" auth-dir: "~/.cli-proxy-api"
# 启用调试日志 # 启用调试日志