pixverse-ai-cli 1.0.11 → 1.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +70 -0
  2. package/dist/index.js +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -51,6 +51,39 @@ This opens your browser where you confirm the authorization. The CLI receives a
51
51
 
52
52
  > You need a PixVerse account to use the CLI. Sign up at [pixverse.ai](https://pixverse.ai) if you don't have one.
53
53
 
54
+ ## Supported Models
55
+
56
+ ### Video Models (`--model <value>`)
57
+
58
+ | Model | `--model` value | Quality | Duration | Aspect Ratio |
59
+ |:---|:---|:---|:---|:---|
60
+ | PixVerse V6 *(default)* | `v6` | `360p` `540p` `720p` `1080p` | `1`–`15`s | `16:9` `4:3` `1:1` `3:4` `9:16` `3:2` `2:3` `21:9` |
61
+ | PixVerse C1 | `pixverse-c1` | `360p` `540p` `720p` `1080p` | `1`–`15`s | `16:9` `4:3` `1:1` `3:4` `9:16` `3:2` `2:3` |
62
+ | PixVerse v5.6 | `v5.6` | `360p` `480p` `540p` `720p` `1080p` | `1`–`10`s | `16:9` `4:3` `1:1` `3:4` `9:16` `3:2` `2:3` |
63
+ | PixVerse v5.5 | `v5.5` | `360p` `480p` `540p` `720p` `1080p` | `1`–`10`s | `16:9` `4:3` `1:1` `3:4` `9:16` `3:2` `2:3` |
64
+ | PixVerse v5 | `v5` | `360p` `480p` `540p` `720p` `1080p` | `1`–`10`s | `16:9` `4:3` `1:1` `3:4` `9:16` `3:2` `2:3` |
65
+ | Sora 2 | `sora-2` | `720p` | `4` `8` `12`s | `16:9` `9:16` |
66
+ | Sora 2 Pro | `sora-2-pro` | `720p` `1080p` | `4` `8` `12`s | `16:9` `9:16` |
67
+ | Veo 3.1 Standard | `veo-3.1-standard` | `720p` `1080p` | `4` `6` `8`s | `16:9` `9:16` |
68
+ | Veo 3.1 Fast | `veo-3.1-fast` | `720p` `1080p` | `4` `6` `8`s | `16:9` `9:16` |
69
+ | Grok Imagine | `grok-imagine` | `480p` `720p` | `1`–`15`s | `16:9` `4:3` `1:1` `9:16` `3:4` `3:2` `2:3` |
70
+
71
+ > Not all models support all creation modes. For per-mode model support (e.g. which models work with Transition, Reference, Motion Control), see the [PixVerse Skills](#for-ai-agents--advanced-usage) documentation.
72
+
73
+ ### Image Models (`--model <value>`)
74
+
75
+ | Model | `--model` value | Quality | Aspect Ratio |
76
+ |:---|:---|:---|:---|
77
+ | Qwen Image *(default)* | `qwen-image` | `720p` `1080p` | `1:1` `16:9` `9:16` `4:3` `3:4` `5:4` `4:5` `3:2` `2:3` `21:9` |
78
+ | Seedream 5.0 Lite | `seedream-5.0-lite` | `1440p` `1800p` | `auto` `1:1` `16:9` `9:16` + more |
79
+ | Seedream 4.5 | `seedream-4.5` | `1440p` `2160p` | `auto` `1:1` `16:9` `9:16` + more |
80
+ | Seedream 4.0 | `seedream-4.0` | `1080p` `1440p` `2160p` | `auto` `1:1` `16:9` `9:16` + more |
81
+ | Gemini 2.5 Flash | `gemini-2.5-flash` | `1080p` | `auto` `1:1` `16:9` `9:16` + more |
82
+ | Gemini 3.0 | `gemini-3.0` | `1080p` `1440p` `2160p` | `auto` `1:1` `16:9` `9:16` + more |
83
+ | Gemini 3.1 Flash | `gemini-3.1-flash` | `512p` `1080p` `1440p` `2160p` | `auto` `1:1` `16:9` `9:16` + more |
84
+
85
+ ---
86
+
54
87
  ## Usage
55
88
 
56
89
  ### Interactive Mode
@@ -120,6 +153,20 @@ pixverse create motion-control --image ./character.png --video ./dance.mp4
120
153
  pixverse create template --template-id 12345 --image ./photo.png
121
154
  ```
122
155
 
156
+ ### Common Creation Flags
157
+
158
+ These flags are available across most `create` subcommands:
159
+
160
+ | Flag | Description |
161
+ |:---|:---|
162
+ | `--count <n>` | Generate multiple variations (1–4, default 1) |
163
+ | `--seed <number>` | Set random seed for reproducible results |
164
+ | `--off-peak` | Use off-peak pricing (lower credit cost) |
165
+ | `--audio` / `--no-audio` | Enable or disable audio generation |
166
+ | `--multi-shot` / `--no-multi-shot` | Enable or disable multi-shot mode (video only) |
167
+ | `--no-wait` | Return immediately without waiting for completion |
168
+ | `--timeout <sec>` | Polling timeout in seconds (default 300) |
169
+
123
170
  ### Task Management
124
171
 
125
172
  ```bash
@@ -292,9 +339,32 @@ pixverse asset download "$VID" --dest ./output/
292
339
  | `-V, --version` | Show CLI version |
293
340
  | `-h, --help` | Show help for any command |
294
341
 
342
+ ## For AI Agents — Advanced Usage
343
+
344
+ For AI agents (Claude Code, Cursor, Codex, etc.), we **strongly recommend** installing [PixVerse Skills](https://github.com/PixVerseAI/skills) — a comprehensive skill library that teaches agents how to use PixVerse CLI correctly with full model constraints, multi-step pipelines, and error handling.
345
+
346
+ **Install via Skills CLI:**
347
+
348
+ ```bash
349
+ npx skills add https://github.com/pixverseai/skills --skill pixverse-ai-image-and-video-generator
350
+ ```
351
+
352
+ **Or browse on ClawHub:**
353
+
354
+ [https://clawhub.ai/pixverse-official/pixverse-ai-image-and-video-generator](https://clawhub.ai/pixverse-official/pixverse-ai-image-and-video-generator)
355
+
356
+ Skills include:
357
+ - Per-model parameter constraints (which models support which modes, quality levels, durations, aspect ratios)
358
+ - End-to-end workflow pipelines (text-to-video, storyboard-to-video, video production, motion control, etc.)
359
+ - Prompt optimization techniques for better generation quality
360
+ - Batch creation patterns and error handling strategies
361
+
295
362
  ## Links
296
363
 
297
364
  - [PixVerse Website](https://pixverse.ai)
365
+ - [PixVerse Skills](https://github.com/PixVerseAI/skills) — Agent skill library
366
+ - [npm Package](https://www.npmjs.com/package/pixverse)
367
+ - [Changelog](https://github.com/PixVerseAI/cli/blob/main/CHANGELOG.md)
298
368
  - [Report Issues](https://github.com/PixVerseAI/cli/issues)
299
369
 
300
370
  ## License