Skip to content

docs: fix video --download example and clarify auth credential locations #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RyanLee-Dev merged 1 commit into from
Apr 11, 2026
Merged

docs: fix video --download example and clarify auth credential locations #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ mmx image generate --prompt "Logo" --out-dir ./out/
### `mmx video`

```bash
mmx video generate --prompt "Ocean waves at sunset" --async
mmx video generate --prompt "A robot painting" --download sunset.mp4
mmx video generate --prompt "Ocean waves at sunset" --download sunset.mp4
mmx video generate --prompt "A robot painting" --async
mmx video task get --task-id 123456
mmx video download --file-id 176844028768320 --out video.mp4
```
Expand Down Expand Up @@ -137,6 +137,10 @@ mmx auth refresh
mmx auth logout
```

`mmx auth status` is the canonical way to verify active authentication.
`~/.mmx/credentials.json` exists only for OAuth login. API-key login persists to
`~/.mmx/config.json` (and `--api-key` can also be passed per command).

### `mmx config` · `mmx quota`

```bash
Expand Down
8 changes: 6 additions & 2 deletions README_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ mmx image generate --prompt "山水画" --out-dir ./output/
### `mmx video`

```bash
mmx video generate --prompt "海浪拍打礁石" --async
mmx video generate --prompt "机器人作画" --download sunset.mp4
mmx video generate --prompt "海浪拍打礁石" --download sunset.mp4
mmx video generate --prompt "机器人作画" --async
mmx video task get --task-id 123456
mmx video download --file-id 176844028768320 --out video.mp4
```
Expand Down Expand Up @@ -137,6 +137,10 @@ mmx auth refresh
mmx auth logout
```

请使用 `mmx auth status` 作为认证状态的权威检查方式。`~/.mmx/credentials.json`
只在 OAuth 登录时存在；API Key 登录会写入 `~/.mmx/config.json`（也可每次通过
`--api-key` 直接传入）。

### `mmx config` · `mmx quota`

```bash
Expand Down
5 changes: 4 additions & 1 deletion skill/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,12 @@ Use `mmx` to generate text, images, video, speech, music, and perform web search
# Install
npm install -g mmx-cli

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

# Verify active auth source
mmx auth status

# Or pass per-call
mmx text chat --api-key sk-xxxxx --message "Hello"
```
Expand Down