Skip to content

Commit 7836d39

Browse files
authored
Merge pull request #84 from however-yir/docs-fix-62-80
docs: fix video --download example and clarify auth credential locations
2 parents 9e9dc54 + ee2bcfa commit 7836d39

File tree

3 files changed

+16
-5
lines changed

3 files changed

+16
-5
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ mmx image generate --prompt "Logo" --out-dir ./out/
8282
### `mmx video`
8383

8484
```bash
85-
mmx video generate --prompt "Ocean waves at sunset" --async
86-
mmx video generate --prompt "A robot painting" --download sunset.mp4
85+
mmx video generate --prompt "Ocean waves at sunset" --download sunset.mp4
86+
mmx video generate --prompt "A robot painting" --async
8787
mmx video task get --task-id 123456
8888
mmx video download --file-id 176844028768320 --out video.mp4
8989
```
@@ -137,6 +137,10 @@ mmx auth refresh
137137
mmx auth logout
138138
```
139139

140+
`mmx auth status` is the canonical way to verify active authentication.
141+
`~/.mmx/credentials.json` exists only for OAuth login. API-key login persists to
142+
`~/.mmx/config.json` (and `--api-key` can also be passed per command).
143+
140144
### `mmx config` · `mmx quota`
141145

142146
```bash

README_CN.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ mmx image generate --prompt "山水画" --out-dir ./output/
8282
### `mmx video`
8383

8484
```bash
85-
mmx video generate --prompt "海浪拍打礁石" --async
86-
mmx video generate --prompt "机器人作画" --download sunset.mp4
85+
mmx video generate --prompt "海浪拍打礁石" --download sunset.mp4
86+
mmx video generate --prompt "机器人作画" --async
8787
mmx video task get --task-id 123456
8888
mmx video download --file-id 176844028768320 --out video.mp4
8989
```
@@ -137,6 +137,10 @@ mmx auth refresh
137137
mmx auth logout
138138
```
139139

140+
请使用 `mmx auth status` 作为认证状态的权威检查方式。`~/.mmx/credentials.json`
141+
只在 OAuth 登录时存在;API Key 登录会写入 `~/.mmx/config.json`(也可每次通过
142+
`--api-key` 直接传入)。
143+
140144
### `mmx config` · `mmx quota`
141145

142146
```bash

skill/SKILL.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,12 @@ Use `mmx` to generate text, images, video, speech, music, and perform web search
1313
# Install
1414
npm install -g mmx-cli
1515

16-
# Auth (persisted to ~/.mmx/credentials.json)
16+
# Auth (OAuth persists to ~/.mmx/credentials.json, API key persists to ~/.mmx/config.json)
1717
mmx auth login --api-key sk-xxxxx
1818

19+
# Verify active auth source
20+
mmx auth status
21+
1922
# Or pass per-call
2023
mmx text chat --api-key sk-xxxxx --message "Hello"
2124
```

0 commit comments

Comments
 (0)