pixverse-ai-cli 1.0.12 → 1.1.0

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 +123 -2
  2. package/dist/index.js +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -51,6 +51,49 @@ 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
+ | PixVerse V5 Fast | `v5-fast` | `360p` `480p` `540p` `720p` `1080p` | `1`–`10`s | `16:9` `4:3` `1:1` `3:4` `9:16` `3:2` `2:3` |
66
+ | PixVerse V4.5 | `v4.5` | `360p` `480p` `540p` `720p` `1080p` | `1`–`10`s | `16:9` `4:3` `1:1` `3:4` `9:16` `3:2` `2:3` |
67
+ | Seedance 2.0 Standard | `seedance-2.0-standard` | `480p` `720p` | `4`–`15`s | `16:9` `4:3` `1:1` `3:4` `9:16` `21:9` |
68
+ | Seedance 2.0 Fast | `seedance-2.0-fast` | `480p` `720p` | `4`–`15`s | `16:9` `4:3` `1:1` `3:4` `9:16` `21:9` |
69
+ | Kling O3 Pro | `kling-o3-pro` | `720p` | `3`–`15`s | `16:9` `9:16` `1:1` |
70
+ | Kling O3 Standard | `kling-o3-standard` | `720p` | `3`–`15`s | `16:9` `9:16` `1:1` |
71
+ | Kling 3.0 Pro | `kling-3.0-pro` | `720p` | `3`–`15`s | `16:9` `9:16` `1:1` |
72
+ | Kling 3.0 Standard | `kling-3.0-standard` | `720p` | `3`–`15`s | `16:9` `9:16` `1:1` |
73
+ | Grok Imagine | `grok-imagine` | `480p` `720p` | `1`–`15`s | `16:9` `4:3` `1:1` `9:16` `3:4` `3:2` `2:3` |
74
+ | Veo 3.1 Standard | `veo-3.1-standard` | `720p` `1080p` | `4` `6` `8`s | `16:9` `9:16` |
75
+ | Veo 3.1 Fast | `veo-3.1-fast` | `720p` `1080p` | `4` `6` `8`s | `16:9` `9:16` |
76
+ | Sora 2 Pro | `sora-2-pro` | `720p` `1080p` | `4` `8` `12`s | `16:9` `9:16` |
77
+ | Sora 2 | `sora-2` | `720p` | `4` `8` `12`s | `16:9` `9:16` |
78
+
79
+ > 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.
80
+
81
+ ### Image Models (`--model <value>`)
82
+
83
+ | Model | `--model` value | Quality | Aspect Ratio |
84
+ |:---|:---|:---|:---|
85
+ | 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` |
86
+ | Nano Banana 2 | `gemini-3.1-flash` | `512p` `1080p` `1440p` `2160p` | `auto` `1:1` `16:9` `9:16` + more |
87
+ | Nano Banana Pro | `gemini-3.0` | `1080p` `1440p` `2160p` | `auto` `1:1` `16:9` `9:16` + more |
88
+ | Nano Banana | `gemini-2.5-flash` | `1080p` | `auto` `1:1` `16:9` `9:16` + more |
89
+ | Seedream 5.0 Lite | `seedream-5.0-lite` | `1440p` `1800p` | `auto` `1:1` `16:9` `9:16` + more |
90
+ | Seedream 4.5 | `seedream-4.5` | `1440p` `2160p` | `auto` `1:1` `16:9` `9:16` + more |
91
+ | Seedream 4.0 | `seedream-4.0` | `1080p` `1440p` `2160p` | `auto` `1:1` `16:9` `9:16` + more |
92
+ | Kling O3 | `kling-image-o3` | `1080p` `1440p` `2160p` | `16:9` `9:16` `1:1` + more |
93
+ | Kling 3.0 | `kling-image-v3` | `1080p` `1440p` | `16:9` `9:16` `1:1` + more |
94
+
95
+ ---
96
+
54
97
  ## Usage
55
98
 
56
99
  ### Interactive Mode
@@ -120,6 +163,20 @@ pixverse create motion-control --image ./character.png --video ./dance.mp4
120
163
  pixverse create template --template-id 12345 --image ./photo.png
121
164
  ```
122
165
 
166
+ ### Common Creation Flags
167
+
168
+ These flags are available across most `create` subcommands:
169
+
170
+ | Flag | Description |
171
+ |:---|:---|
172
+ | `--count <n>` | Generate multiple variations (1–4, default 1) |
173
+ | `--seed <number>` | Set random seed for reproducible results |
174
+ | `--off-peak` | Use off-peak pricing (lower credit cost) |
175
+ | `--audio` / `--no-audio` | Enable or disable audio generation |
176
+ | `--multi-shot` / `--no-multi-shot` | Enable or disable multi-shot mode (video only) |
177
+ | `--no-wait` | Return immediately without waiting for completion |
178
+ | `--timeout <sec>` | Polling timeout in seconds (default 300) |
179
+
123
180
  ### Task Management
124
181
 
125
182
  ```bash
@@ -133,8 +190,15 @@ pixverse task wait <id>
133
190
  ### Asset Management
134
191
 
135
192
  ```bash
136
- # List your generated assets
193
+ # List your generated assets (default: created videos)
137
194
  pixverse asset list
195
+ pixverse asset list --type image
196
+ pixverse asset list --source upload
197
+ pixverse asset list --source create --off-peak
198
+
199
+ # Upload a local file or URL to asset library
200
+ pixverse asset upload ./photo.png
201
+ pixverse asset upload https://example.com/image.jpg
138
202
 
139
203
  # Get asset details
140
204
  pixverse asset info <id>
@@ -146,6 +210,32 @@ pixverse asset download <id>
146
210
  pixverse asset delete <id>
147
211
  ```
148
212
 
213
+ ### Saved Folders
214
+
215
+ ```bash
216
+ # List all saved folders
217
+ pixverse saved list
218
+
219
+ # List items in a folder (default folder if omitted)
220
+ pixverse saved items
221
+ pixverse saved items <folder_id> --type image --source upload
222
+
223
+ # Create a new folder
224
+ pixverse saved new "My Collection"
225
+
226
+ # Rename a folder
227
+ pixverse saved rename <folder_id> "New Name"
228
+
229
+ # Add assets to a folder
230
+ pixverse saved add <asset_id...> --folder <folder_id> --type video
231
+
232
+ # Remove assets from a folder
233
+ pixverse saved remove <asset_id...> --folder <folder_id> --type video
234
+
235
+ # Delete a folder
236
+ pixverse saved delete <folder_id>
237
+ ```
238
+
149
239
  ### Templates
150
240
 
151
241
  ```bash
@@ -264,10 +354,18 @@ pixverse asset download "$VID" --dest ./output/
264
354
  | `template info` | Get template details |
265
355
  | `task status` | Check task status |
266
356
  | `task wait` | Wait for task completion |
267
- | `asset list` | List generated assets |
357
+ | `asset list` | List assets (`--source create\|upload`, `--type video\|image`, `--off-peak`) |
358
+ | `asset upload` | Upload a local file or HTTPS URL to asset library |
268
359
  | `asset info` | Get asset details |
269
360
  | `asset download` | Download a generated asset |
270
361
  | `asset delete` | Delete an asset |
362
+ | `saved list` | List saved folders |
363
+ | `saved items` | List items in a saved folder |
364
+ | `saved new` | Create a new saved folder |
365
+ | `saved rename` | Rename a saved folder |
366
+ | `saved add` | Add assets to a saved folder |
367
+ | `saved remove` | Remove assets from a saved folder |
368
+ | `saved delete` | Delete a saved folder |
271
369
  | `workspace list` | List all workspaces |
272
370
  | `workspace status` | Show current workspace |
273
371
  | `workspace switch` | Switch workspace (interactive or by ID) |
@@ -292,9 +390,32 @@ pixverse asset download "$VID" --dest ./output/
292
390
  | `-V, --version` | Show CLI version |
293
391
  | `-h, --help` | Show help for any command |
294
392
 
393
+ ## For AI Agents — Advanced Usage
394
+
395
+ 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.
396
+
397
+ **Install via Skills CLI:**
398
+
399
+ ```bash
400
+ npx skills add https://github.com/pixverseai/skills --skill pixverse-ai-image-and-video-generator
401
+ ```
402
+
403
+ **Or browse on ClawHub:**
404
+
405
+ [https://clawhub.ai/pixverse-official/pixverse-ai-image-and-video-generator](https://clawhub.ai/pixverse-official/pixverse-ai-image-and-video-generator)
406
+
407
+ Skills include:
408
+ - Per-model parameter constraints (which models support which modes, quality levels, durations, aspect ratios)
409
+ - End-to-end workflow pipelines (text-to-video, storyboard-to-video, video production, motion control, etc.)
410
+ - Prompt optimization techniques for better generation quality
411
+ - Batch creation patterns and error handling strategies
412
+
295
413
  ## Links
296
414
 
297
415
  - [PixVerse Website](https://pixverse.ai)
416
+ - [PixVerse Skills](https://github.com/PixVerseAI/skills) — Agent skill library
417
+ - [npm Package](https://www.npmjs.com/package/pixverse)
418
+ - [Changelog](https://github.com/PixVerseAI/cli/blob/main/CHANGELOG.md)
298
419
  - [Report Issues](https://github.com/PixVerseAI/cli/issues)
299
420
 
300
421
  ## License