Skip to content

Commit 221dbc4

Browse files
RyanLee-Devclaude
andcommitted
docs+refactor: trim README sections, reduce global flags
- README.md, README_CN.md: remove Global Flags table, Agent/CI Integration, and Output Philosophy sections - GLOBAL_OPTIONS: remove --yes and --async (command-specific) - auth logout: add --yes to own options - registry help: remove --yes and --async from global flags listing Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 5def3a7 commit 221dbc4

5 files changed

Lines changed: 3 additions & 102 deletions

File tree

README.md

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -128,55 +128,6 @@ minimax update latest
128128

129129
---
130130

131-
## Global Flags
132-
133-
| Flag | Description |
134-
|---|---|
135-
| `--api-key <key>` | API key (overrides config) |
136-
| `--region <global\|cn>` | API region |
137-
| `--output <text\|json\|yaml>` | Output format |
138-
| `--quiet` | Data only on stdout, no decorations |
139-
| `--verbose` | Print HTTP request/response |
140-
| `--dry-run` | Show request body, no API call |
141-
| `--async` | Return task ID immediately (video) |
142-
| `--non-interactive` | Disable prompts (CI/agent mode) |
143-
| `--timeout <seconds>` | Request timeout (default: 300) |
144-
| `--no-color` | Disable ANSI colors |
145-
146-
Add `--help` to any command for full options.
147-
148-
---
149-
150-
## Agent / CI Integration
151-
152-
Export all commands as JSON Tool Schema in one shot:
153-
154-
```bash
155-
minimax config export-schema | jq .
156-
minimax config export-schema --command "text chat"
157-
```
158-
159-
Compatible with Cursor, Cline, Dify, and any framework that speaks Anthropic/OpenAI tool schemas. See [skill/SKILL.md](skill/SKILL.md) for the full integration guide.
160-
161-
**Piping:**
162-
163-
```bash
164-
minimax text chat --message "Hello" --output json | jq .content
165-
minimax image "A logo" --quiet | xargs curl -O
166-
minimax video generate --prompt "A robot" --async --quiet
167-
```
168-
169-
stdout is always clean data. stderr carries all UI (status bar, spinners, progress).
170-
171-
---
172-
173-
## Output Philosophy
174-
175-
- `stdout` → data only (text, URLs, JSON, raw audio bytes)
176-
- `stderr` → status bar, progress, warnings, help
177-
178-
---
179-
180131
## License
181132

182133
MIT

README_CN.md

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -128,55 +128,6 @@ minimax update latest
128128

129129
---
130130

131-
## 全局 Flag
132-
133-
| Flag | 说明 |
134-
|---|---|
135-
| `--api-key <key>` | API Key(覆盖配置文件) |
136-
| `--region <global\|cn>` | 接口区域 |
137-
| `--output <text\|json\|yaml>` | 输出格式 |
138-
| `--quiet` | 只输出数据,无装饰信息 |
139-
| `--verbose` | 打印 HTTP 请求/响应详情 |
140-
| `--dry-run` | 展示请求体,不发起 API 调用 |
141-
| `--async` | 立即返回任务 ID(视频异步模式) |
142-
| `--non-interactive` | 禁用交互提示(CI/Agent 模式) |
143-
| `--timeout <秒>` | 请求超时(默认 300 秒) |
144-
| `--no-color` | 关闭 ANSI 颜色 |
145-
146-
任意命令后加 `--help` 查看完整参数。
147-
148-
---
149-
150-
## Agent / CI 集成
151-
152-
一键导出所有命令的 JSON Tool Schema:
153-
154-
```bash
155-
minimax config export-schema | jq .
156-
minimax config export-schema --command "text chat"
157-
```
158-
159-
兼容 Cursor、Cline、Dify 等任何支持 Anthropic/OpenAI Tool Schema 的 Agent 框架。完整集成指南见 [skill/SKILL.md](skill/SKILL.md)
160-
161-
**管道用法:**
162-
163-
```bash
164-
minimax text chat --message "你好" --output json | jq .content
165-
minimax image "Logo" --quiet | xargs curl -O
166-
minimax video generate --prompt "机器人" --async --quiet
167-
```
168-
169-
stdout 始终是纯净数据,stderr 承载所有 UI(状态栏、进度、警告)。
170-
171-
---
172-
173-
## 输出规范
174-
175-
- `stdout` → 纯数据(文字、URL、JSON、原始音频字节流)
176-
- `stderr` → 状态栏、进度条、警告、帮助信息
177-
178-
---
179-
180131
## 许可证
181132

182133
MIT

src/command.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,8 @@ export const GLOBAL_OPTIONS: OptionDef[] = [
4747
{ flag: '--quiet', description: 'Suppress non-essential output' },
4848
{ flag: '--verbose', description: 'Print HTTP request/response details' },
4949
{ flag: '--no-color', description: 'Disable ANSI colors' },
50-
{ flag: '--yes', description: 'Skip confirmation prompts' },
5150
{ flag: '--dry-run', description: 'Dry run mode' },
5251
{ flag: '--non-interactive', description: 'Disable interactive prompts' },
53-
{ flag: '--async', description: 'Return task ID immediately' },
5452
{ flag: '--help', description: 'Show help' },
5553
{ flag: '--version', description: 'Print version' },
5654
];

src/commands/auth/logout.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ export default defineCommand({
88
name: 'auth logout',
99
description: 'Revoke tokens and clear stored credentials',
1010
usage: 'minimax auth logout [--yes] [--dry-run]',
11+
options: [
12+
{ flag: '--yes', description: 'Skip confirmation prompt' },
13+
],
1114
examples: [
1215
'minimax auth logout',
1316
'minimax auth logout --dry-run',

src/registry.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,10 +165,8 @@ Global Flags:
165165
--verbose Print HTTP request/response details
166166
--timeout <seconds> Request timeout (default: 300)
167167
--no-color Disable ANSI colors and spinners
168-
--yes Skip confirmation prompts
169168
--dry-run Show what would happen without executing
170169
--non-interactive Disable interactive prompts (CI/agent mode)
171-
--async Return task ID immediately without polling
172170
--version Print version and exit
173171
--help Show help
174172

0 commit comments

Comments
 (0)