WHCandCursor
1f1fcba7ad
Vendored sashidown, OpenAI-compatible env (OPENAI_*), and bootstrap scripts. Co-authored-by: Cursor <cursoragent@cursor.com>
74 lines
2.0 KiB
Markdown
74 lines
2.0 KiB
Markdown
# OpenAI 兼容 API 环境变量
|
||
|
||
CST-Agent 使用 **OpenAI Chat Completions** 协议（`POST {base}/chat/completions`），
|
||
可对接官方 OpenAI、MiniMax、以及其它兼容网关。
|
||
|
||
## 必填 / 常用
|
||
|
||
| 变量 | 别名 | 说明 | 示例 |
|
||
|---|---|---|---|
|
||
| `CST_API_KEY` | `OPENAI_API_KEY`、`MINIMAX_API_KEY` | API Key（按此优先级读取） | `sk-...` |
|
||
| `CST_API_BASE` | `OPENAI_BASE_URL`、`OPENAI_API_BASE` | API 根路径，须含 `/v1`（不要带 `/chat/completions`） | `https://api.openai.com/v1` |
|
||
| `CST_MODEL` | `OPENAI_MODEL` | 模型名 | `gpt-4.1-mini` / `MiniMax-M2.7` |
|
||
|
||
未设置 key 时：读配置文件 →（Linux）zenity / 控制台输入。
|
||
|
||
配置文件：
|
||
- Linux/Termux：`~/.config/cst-agent/credentials`
|
||
- Windows：`%APPDATA%\cst-agent\credentials`
|
||
|
||
## 示例
|
||
|
||
### OpenAI 官方
|
||
|
||
```bash
|
||
export OPENAI_API_KEY='sk-...'
|
||
export OPENAI_BASE_URL='https://api.openai.com/v1'
|
||
export OPENAI_MODEL='gpt-4.1-mini'
|
||
./cst-agent --workspace .
|
||
```
|
||
|
||
等价 CST 前缀：
|
||
|
||
```bash
|
||
export CST_API_KEY='sk-...'
|
||
export CST_API_BASE='https://api.openai.com/v1'
|
||
export CST_MODEL='gpt-4.1-mini'
|
||
```
|
||
|
||
### MiniMax（默认）
|
||
|
||
```bash
|
||
export CST_API_KEY='...' # 或 MINIMAX_API_KEY
|
||
# 默认 base=https://api.minimax.cn/v1 model=MiniMax-M2.7
|
||
./cst-agent --workspace .
|
||
```
|
||
|
||
### 任意兼容网关
|
||
|
||
```bash
|
||
export OPENAI_API_KEY='...'
|
||
export OPENAI_BASE_URL='https://your-gateway.example/v1'
|
||
export OPENAI_MODEL='your-model'
|
||
./cst-agent --headless --prompt 'ping' --workspace .
|
||
```
|
||
|
||
命令行也可覆盖：`--api-base` / `--api-key` / `--model`。
|
||
|
||
## 其它环境变量
|
||
|
||
| 变量 | 说明 |
|
||
|---|---|
|
||
| `CST_MODELS` | `/model` 可选列表，`:` 或 `,` 分隔 |
|
||
| `CST_AUTO_APPROVE=1` | 自动允许 shell/写文件（headless 常用） |
|
||
| `CST_SHELL` | shell 解释器路径（覆盖 busybox/`sh`） |
|
||
| `CST_EXE_DIR` | 可执行文件目录（Termux 旁路 busybox 时有用） |
|
||
|
||
## CLI 对照
|
||
|
||
```text
|
||
--api-base URL ← CST_API_BASE / OPENAI_BASE_URL
|
||
--api-key KEY ← CST_API_KEY / OPENAI_API_KEY
|
||
--model NAME ← CST_MODEL / OPENAI_MODEL
|
||
```
|