Skip to content

feat(docs): add mmx help command + API doc links to --help#76

Merged
tars90percent merged 2 commits intoMiniMax-AI:mainfrom
raylanlin:pr/docs
Apr 10, 2026
Merged

feat(docs): add mmx help command + API doc links to --help#76
tars90percent merged 2 commits intoMiniMax-AI:mainfrom
raylanlin:pr/docs

Conversation

@raylanlin
Copy link
Copy Markdown

Changes

  • mmx help: New command listing all official MiniMax API documentation links
  • API Reference in --help: Every command's --help now shows its official API doc URL at the bottom
  • Updated model lists in --help:
    • text chat: all 7 models (M2.7, M2.7-highspeed, M2.5, M2.5-highspeed, M2.1, M2, Text-01)
    • speech synthesize: all 8 models (speech-2.8/2.6/02/01, each with hd/turbo)
    • image generate: image-01 / image-01-live
    • video generate: Hailuo-2.3 / 2.3-Fast / Hailuo-02

Files

  • src/commands/help.ts (new)
  • src/registry.ts (register help, display apiDocs)
  • src/command.ts (apiDocs interface)
  • src/commands/text/chat.ts
  • src/commands/speech/synthesize.ts
  • src/commands/image/generate.ts
  • src/commands/video/generate.ts
  • src/commands/music/generate.ts

Raylan LIN and others added 2 commits April 10, 2026 19:43
- New 'mmx help' command listing all official API doc links
- Add apiDocs field to Command interface (command.ts)
- Register apiDocs display in registry printCommandHelp
- Add apiDocs to: text chat, speech synthesize, image generate,
  video generate, music generate, music cover
- Update text chat --model: list all 7 models (M2.7/highspeed/M2.5/M2.5-highspeed/M2.1/M2/Text-01)
- Update speech synthesize: 8 models (2.8/2.6/02/01 hd+turbo)
- Update image description: image-01/image-01-live
- Update video description: Hailuo-2.3/2.3-Fast/Hailuo-02
- Change all apiDocs from full URLs to paths (works with DOCS_HOSTS)
- Make help command region-aware using DOCS_HOSTS + config.region
- Remove self-referential apiDocs from help command
- Add missing apiDocs to speech/synthesize (was claimed in PR body)
@tars90percent tars90percent merged commit 0cda729 into MiniMax-AI:main Apr 10, 2026
@tars90percent
Copy link
Copy Markdown
Collaborator

Thanks! Rebased onto main to resolve conflicts with f9a3ecb, and pushed fixes:

  • All apiDocs values changed to path-only (same pattern as other PRs -- full URLs broke when concatenated with DOCS_HOSTS[region])
  • help.ts now uses DOCS_HOSTS[config.region] instead of hardcoding platform.minimax.io -- the previous version was breaking --region cn users
  • Added the apiDocs to speech/synthesize.ts that was mentioned in the PR description but missing from the diff

Apologies for pushing directly rather than requesting changes -- should have let you address these yourself. Will do that next time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants