|
1 | 1 | --- |
2 | 2 | name: wavespeed-cli |
3 | | -description: Generate, edit, animate, upscale, or transform AI media using the WaveSpeed CLI from Codex. Use when the user asks to create image, video, audio, 3D, TTS, marketing creatives, or to inspect/run WaveSpeed models. |
| 3 | +description: Generate or edit AI media (image, video, audio, 3D) on WaveSpeed, through the WaveSpeed MCP tools when they are connected or the wavespeed CLI on the user's machine. Use whenever the user asks to create, edit, animate, extend, upscale, or transform an image or video, generate audio/TTS/music or 3D, or produce marketing creatives. |
4 | 4 | --- |
5 | 5 |
|
6 | | -# WaveSpeed CLI |
| 6 | +# WaveSpeed |
7 | 7 |
|
8 | | -Use the `wavespeed` CLI to run WaveSpeed image, video, audio, and 3D models: the shortcuts for plain images and videos, and the generic run for every other model. |
| 8 | +WaveSpeed runs every model on its platform. There are two ways in, and they do the same things: |
9 | 9 |
|
10 | | -This plugin also starts the WaveSpeed MCP server. Its tools map one-to-one onto the CLI commands below: `list_models` = `wavespeed models`, `get_model_schema` = `wavespeed schema`, `get_price` = `wavespeed price`, `upload_file` = `wavespeed upload`, `run_model` = `wavespeed run`, `generate_image` / `edit_image` / `generate_video` / `edit_video` / `extend_video` = `wavespeed generate|edit|extend`, `get_prediction` = `wavespeed show`, `get_balance` = `wavespeed balance`. Prefer the MCP tools for single generations; use the CLI when it is installed and the user wants batch or scripted runs. Both share the same login. |
| 10 | +- **MCP tools** (`generate_image`, `generate_video`, …): use them when the WaveSpeed MCP server is connected. The hosted server cannot read local files: pass public URLs, or use the CLI for files on disk. |
| 11 | +- **The `wavespeed` CLI**: use it when it is installed, for local files (`@./path`), batches and scripts. |
11 | 12 |
|
12 | | -## Before Running |
13 | | - |
14 | | -Check whether the CLI is available: |
15 | | - |
16 | | -```bash |
17 | | -wavespeed --version |
18 | | -``` |
19 | | - |
20 | | -If it is missing, run this plugin helper: |
21 | | - |
22 | | -```bash |
23 | | -./plugins/wavespeed-cli/scripts/install-wavespeed-cli.sh |
24 | | -``` |
25 | | - |
26 | | -Check auth before generation: |
27 | | - |
28 | | -```bash |
29 | | -wavespeed status |
30 | | -``` |
31 | | - |
32 | | -If the user is not signed in, ask them to run `wavespeed login`. Do not ask the user to paste an API key into chat. For CI or one-off shells, `WAVESPEED_API_KEY` may be set in the environment. |
| 13 | +For plain image and video work, use the shortcuts. For anything else (audio, 3D, upscaling, a specific endpoint, exact parameters), use the generic run. |
33 | 14 |
|
34 | 15 | ## Images and videos: the shortcuts |
35 | 16 |
|
@@ -96,6 +77,11 @@ If `wavespeed.json` exists (created by `wavespeed init`): |
96 | 77 | - **`defaultModel`** lets `wavespeed run -p "…"` (no model arg) work. |
97 | 78 | - **Aliases** are named shortcuts that bundle model + default inputs. Run `wavespeed aliases` to see them; `wavespeed run <alias> -h` shows the resolved schema. CLI `-i k=v` overrides alias defaults. |
98 | 79 |
|
| 80 | +## Auth |
| 81 | + |
| 82 | +- CLI: `wavespeed status` shows whether the user is signed in. If not, ask them to run `wavespeed login` (opens https://wavespeed.ai/accesskey). |
| 83 | +- MCP: if the tools ask for authorization, the user approves the connection once in the Codex connection prompt. |
| 84 | +- **Never** ask the user to paste an API key into the chat. |
99 | 85 |
|
100 | 86 | ## Cost and credits |
101 | 87 |
|
|
0 commit comments