From ee2bcfab2ab6592c64140fcfffbb9248c5e6f41d Mon Sep 17 00:00:00 2001 From: however Date: Sat, 11 Apr 2026 17:12:46 +0800 Subject: [PATCH] docs: fix video download example and clarify auth credential locations --- README.md | 8 ++++++-- README_CN.md | 8 ++++++-- skill/SKILL.md | 5 ++++- 3 files changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index dbcfaa8..d888a69 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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 diff --git a/README_CN.md b/README_CN.md index ec50909..13fc9de 100644 --- a/README_CN.md +++ b/README_CN.md @@ -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 ``` @@ -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 diff --git a/skill/SKILL.md b/skill/SKILL.md index 7f64e6a..8f30450 100644 --- a/skill/SKILL.md +++ b/skill/SKILL.md @@ -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" ```