pixverse-cli 1.1.11 → 1.2.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.
- package/README.md +91 -18
- package/dist/capabilities.json +913 -0
- package/dist/index.js +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,913 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schema_version": "1.1.0",
|
|
3
|
+
"format": "pixverse-cli-capabilities-compact",
|
|
4
|
+
"source": "Generated from Commander definitions by scripts/generate-capabilities.mjs. Do not hand-edit.",
|
|
5
|
+
"cli": {
|
|
6
|
+
"name": "pixverse",
|
|
7
|
+
"package": "pixverse",
|
|
8
|
+
"version": "1.2.0",
|
|
9
|
+
"binary": "pixverse",
|
|
10
|
+
"node": ">=20",
|
|
11
|
+
"description": "PixVerse CLI - generate videos and images from the command line"
|
|
12
|
+
},
|
|
13
|
+
"contract": {
|
|
14
|
+
"service": "PixVerse public service",
|
|
15
|
+
"auth": "OAuth device flow with a local CLI session",
|
|
16
|
+
"json": "Use --json or -p for pure JSON stdout; errors and progress go to stderr.",
|
|
17
|
+
"text_inputs": "prompt, text, lyrics accept literal text, local file path, or - for stdin.",
|
|
18
|
+
"polling": "done=1; retry=5,9,10; failed=7,8; intervals=2s,5s,10s"
|
|
19
|
+
},
|
|
20
|
+
"exit_codes": {
|
|
21
|
+
"0": "SUCCESS: success",
|
|
22
|
+
"1": "GENERAL_ERROR: general API or unexpected error",
|
|
23
|
+
"2": "TIMEOUT: polling timeout",
|
|
24
|
+
"3": "AUTH_EXPIRED: authentication token invalid or expired",
|
|
25
|
+
"4": "CREDIT_INSUFFICIENT: subscription or credit limit",
|
|
26
|
+
"5": "GENERATION_FAILED: generation failed or was not approved",
|
|
27
|
+
"6": "VALIDATION_ERROR: CLI input validation error"
|
|
28
|
+
},
|
|
29
|
+
"global_options": {
|
|
30
|
+
"-V, --version": "output the version number",
|
|
31
|
+
"--json": "Output results as JSON",
|
|
32
|
+
"-p": "Print mode - pure JSON output (alias for --json)",
|
|
33
|
+
"--workspace-id <id>": "Override active workspace for this command (0 = personal)",
|
|
34
|
+
"--trace-id <id>": "Trace ID to attach to all API requests in this invocation (must be UUIDv4)"
|
|
35
|
+
},
|
|
36
|
+
"commands": [
|
|
37
|
+
{
|
|
38
|
+
"cmd": "pixverse",
|
|
39
|
+
"desc": "PixVerse CLI - generate videos and images from the command line",
|
|
40
|
+
"children": [
|
|
41
|
+
"auth",
|
|
42
|
+
"create",
|
|
43
|
+
"task",
|
|
44
|
+
"asset",
|
|
45
|
+
"account",
|
|
46
|
+
"subscribe",
|
|
47
|
+
"config",
|
|
48
|
+
"template",
|
|
49
|
+
"voice",
|
|
50
|
+
"music",
|
|
51
|
+
"saved",
|
|
52
|
+
"workspace",
|
|
53
|
+
"update"
|
|
54
|
+
],
|
|
55
|
+
"options": {
|
|
56
|
+
"-V, --version": "output the version number",
|
|
57
|
+
"--json": "Output results as JSON",
|
|
58
|
+
"-p": "Print mode - pure JSON output (alias for --json)",
|
|
59
|
+
"--workspace-id <id>": "Override active workspace for this command (0 = personal)",
|
|
60
|
+
"--trace-id <id>": "Trace ID to attach to all API requests in this invocation (must be UUIDv4)"
|
|
61
|
+
}
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"cmd": "pixverse auth",
|
|
65
|
+
"desc": "Manage authentication",
|
|
66
|
+
"children": [
|
|
67
|
+
"login",
|
|
68
|
+
"status",
|
|
69
|
+
"logout"
|
|
70
|
+
]
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"cmd": "pixverse auth login",
|
|
74
|
+
"desc": "Login via browser authorization (OAuth device flow)",
|
|
75
|
+
"run": true,
|
|
76
|
+
"effect": "mutates_cli_or_remote_state",
|
|
77
|
+
"options": {
|
|
78
|
+
"--json": "Output as JSON"
|
|
79
|
+
}
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"cmd": "pixverse auth status",
|
|
83
|
+
"desc": "Check authentication status and account info",
|
|
84
|
+
"run": true,
|
|
85
|
+
"auth": true,
|
|
86
|
+
"options": {
|
|
87
|
+
"--json": "Output as JSON"
|
|
88
|
+
}
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"cmd": "pixverse auth logout",
|
|
92
|
+
"desc": "Remove stored token",
|
|
93
|
+
"run": true,
|
|
94
|
+
"effect": "destructive_remote_or_local_change",
|
|
95
|
+
"destructive": true,
|
|
96
|
+
"options": {
|
|
97
|
+
"--json": "Output as JSON"
|
|
98
|
+
}
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"cmd": "pixverse create",
|
|
102
|
+
"desc": "Create videos, images, and audio",
|
|
103
|
+
"children": [
|
|
104
|
+
"video",
|
|
105
|
+
"image",
|
|
106
|
+
"transition",
|
|
107
|
+
"voice",
|
|
108
|
+
"music",
|
|
109
|
+
"extend",
|
|
110
|
+
"modify",
|
|
111
|
+
"upscale",
|
|
112
|
+
"reference",
|
|
113
|
+
"motion-control",
|
|
114
|
+
"template"
|
|
115
|
+
]
|
|
116
|
+
},
|
|
117
|
+
{
|
|
118
|
+
"cmd": "pixverse create video",
|
|
119
|
+
"desc": "Text/image to video (T2V / I2V)",
|
|
120
|
+
"run": true,
|
|
121
|
+
"auth": true,
|
|
122
|
+
"effect": "creates_remote_media_asset",
|
|
123
|
+
"options": {
|
|
124
|
+
"--prompt <text>": "Prompt text - literal, a local file path, or - for stdin (required)",
|
|
125
|
+
"--image <input>": "Image input: file path, HTTPS URL, image ID, or media path (local oversized images are auto-resized to fit 1920x1920)",
|
|
126
|
+
"-m, --model <model>": "Video model",
|
|
127
|
+
"-d, --duration <seconds>": "Duration in seconds",
|
|
128
|
+
"-q, --quality <quality>": "Video quality",
|
|
129
|
+
"--aspect-ratio <ratio>": "Aspect ratio",
|
|
130
|
+
"--seed <number>": "Random seed",
|
|
131
|
+
"--count <number>": "Number of generations",
|
|
132
|
+
"--audio": "Enable audio generation",
|
|
133
|
+
"--no-audio": "Disable audio generation | negates: audio",
|
|
134
|
+
"--multi-shot": "Enable multi-shot mode",
|
|
135
|
+
"--no-multi-shot": "Disable multi-shot mode | negates: multiShot",
|
|
136
|
+
"--off-peak": "Use off-peak pricing",
|
|
137
|
+
"--idempotency-key <key>": "Idempotency key for safe retry - backend dedupes by key so repeated submissions return the original task without re-charging",
|
|
138
|
+
"--no-wait": "Return immediately without polling | negates: wait",
|
|
139
|
+
"--timeout <seconds>": "Polling timeout in seconds | default: 300",
|
|
140
|
+
"--json": "Output as JSON"
|
|
141
|
+
}
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"cmd": "pixverse create image",
|
|
145
|
+
"desc": "Text/image to image (T2I / I2I)",
|
|
146
|
+
"run": true,
|
|
147
|
+
"auth": true,
|
|
148
|
+
"effect": "creates_remote_media_asset",
|
|
149
|
+
"options": {
|
|
150
|
+
"--prompt <text>": "Prompt text - literal, a local file path, or - for stdin (required)",
|
|
151
|
+
"--image <input>": "Single image input: file path, HTTPS URL, image ID, or media path (local oversized images are auto-resized to fit 1920x1920)",
|
|
152
|
+
"--images <inputs...>": "Multiple image inputs: file paths, HTTPS URLs, image IDs, or media paths (local oversized images are auto-resized to fit 1920x1920)",
|
|
153
|
+
"-m, --model <model>": "Image model",
|
|
154
|
+
"-q, --quality <quality>": "Image quality",
|
|
155
|
+
"--aspect-ratio <ratio>": "Aspect ratio",
|
|
156
|
+
"--detail-level <level>": "Detail level for gpt-image-2.0: low | medium | high",
|
|
157
|
+
"--count <number>": "Number of generations",
|
|
158
|
+
"--seed <number>": "Random seed",
|
|
159
|
+
"--idempotency-key <key>": "Idempotency key for safe retry - backend dedupes by key so repeated submissions return the original task without re-charging",
|
|
160
|
+
"--no-wait": "Return immediately without polling | negates: wait",
|
|
161
|
+
"--timeout <seconds>": "Polling timeout in seconds | default: 300",
|
|
162
|
+
"--json": "Output as JSON"
|
|
163
|
+
}
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"cmd": "pixverse create transition",
|
|
167
|
+
"desc": "Multi-frame keyframe transition video",
|
|
168
|
+
"run": true,
|
|
169
|
+
"auth": true,
|
|
170
|
+
"effect": "creates_remote_media_asset",
|
|
171
|
+
"options": {
|
|
172
|
+
"--images <inputs...>": "Image inputs: file paths, HTTPS URLs, image IDs, or media paths (2+ required; local oversized images are auto-resized to fit 1920x1920)",
|
|
173
|
+
"--prompt <text>": "Prompt text",
|
|
174
|
+
"-m, --model <model>": "Video model",
|
|
175
|
+
"-q, --quality <quality>": "Video quality",
|
|
176
|
+
"-d, --duration <seconds>": "Duration in seconds",
|
|
177
|
+
"--count <number>": "Number of generations",
|
|
178
|
+
"--seed <number>": "Random seed",
|
|
179
|
+
"--audio": "Enable audio generation",
|
|
180
|
+
"--no-audio": "Disable audio generation | negates: audio",
|
|
181
|
+
"--off-peak": "Use off-peak pricing",
|
|
182
|
+
"--idempotency-key <key>": "Idempotency key for safe retry - backend dedupes by key so repeated submissions return the original task without re-charging",
|
|
183
|
+
"--no-wait": "Return immediately without polling | negates: wait",
|
|
184
|
+
"--timeout <seconds>": "Polling timeout in seconds | default: 300",
|
|
185
|
+
"--json": "Output as JSON"
|
|
186
|
+
}
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"cmd": "pixverse create voice",
|
|
190
|
+
"desc": "Generate speech audio from text (TTS)",
|
|
191
|
+
"run": true,
|
|
192
|
+
"auth": true,
|
|
193
|
+
"effect": "creates_remote_media_asset",
|
|
194
|
+
"options": {
|
|
195
|
+
"--text <str>": "Text to synthesize - literal, a local file path, or - for stdin",
|
|
196
|
+
"-m, --model <id>": "Voice/TTS model | default: speech-2.8-hd",
|
|
197
|
+
"--voice-id <id>": "PixVerse preset voice ID (recommended)",
|
|
198
|
+
"--provider-voice-id <id>": "Provider raw voice ID",
|
|
199
|
+
"--language <code>": "Language code (default: auto) | default: auto",
|
|
200
|
+
"--stability <0..1>": "ElevenLabs stability",
|
|
201
|
+
"--similarity-boost <0..1>": "ElevenLabs similarity boost",
|
|
202
|
+
"--style <0..1>": "ElevenLabs style (eleven-multilingual-v2 only)",
|
|
203
|
+
"--use-speaker-boost": "ElevenLabs speaker boost (eleven-multilingual-v2 only)",
|
|
204
|
+
"--no-use-speaker-boost": "Disable ElevenLabs speaker boost | negates: useSpeakerBoost",
|
|
205
|
+
"--speed <n>": "Speech speed (default 1.0; EL 0.7..1.2, MM 0.5..2.0)",
|
|
206
|
+
"--volume <0..10>": "MiniMax volume",
|
|
207
|
+
"--pitch <-12..12>": "MiniMax pitch",
|
|
208
|
+
"--emotion <enum>": "MiniMax emotion preset",
|
|
209
|
+
"--client-request-id <id>": "Caller-side request id (logged only)",
|
|
210
|
+
"--output <path>": "Download the finished audio to this file/dir",
|
|
211
|
+
"--no-wait": "Return immediately without polling | negates: wait",
|
|
212
|
+
"--timeout <seconds>": "Polling timeout in seconds | default: 300",
|
|
213
|
+
"--json": "Output as JSON"
|
|
214
|
+
}
|
|
215
|
+
},
|
|
216
|
+
{
|
|
217
|
+
"cmd": "pixverse create music",
|
|
218
|
+
"desc": "Generate music audio from a prompt",
|
|
219
|
+
"run": true,
|
|
220
|
+
"auth": true,
|
|
221
|
+
"effect": "creates_remote_media_asset",
|
|
222
|
+
"options": {
|
|
223
|
+
"--prompt <text>": "Music prompt - literal, a local file path, or - for stdin (required)",
|
|
224
|
+
"--lyrics <text>": "Lyrics for models that support lyrics - literal, a local file path, or - for stdin",
|
|
225
|
+
"-m, --model <id>": "Music model | default: music-2.6",
|
|
226
|
+
"--instrumental": "Generate instrumental music",
|
|
227
|
+
"--auto-lyrics": "Let the model generate lyrics",
|
|
228
|
+
"--no-duration-auto": "Disable automatic duration selection | negates: durationAuto",
|
|
229
|
+
"--duration-seconds <seconds>": "Target duration in seconds (sets duration_auto=false)",
|
|
230
|
+
"--image <input...>": "Reference image(s) for Google Lyria: file path, HTTPS URL, image ID, or media path",
|
|
231
|
+
"--client-request-id <id>": "Caller-side request id (logged only)",
|
|
232
|
+
"--output <path>": "Download the finished music to this file/dir",
|
|
233
|
+
"--no-wait": "Return immediately without polling | negates: wait",
|
|
234
|
+
"--timeout <seconds>": "Polling timeout in seconds | default: 300",
|
|
235
|
+
"--json": "Output as JSON"
|
|
236
|
+
}
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
"cmd": "pixverse create extend",
|
|
240
|
+
"desc": "Extend an existing video",
|
|
241
|
+
"run": true,
|
|
242
|
+
"auth": true,
|
|
243
|
+
"effect": "creates_remote_media_asset",
|
|
244
|
+
"options": {
|
|
245
|
+
"--video <input>": "Video input: file path, HTTPS URL, video ID, or media path",
|
|
246
|
+
"--prompt <text>": "Prompt for extension",
|
|
247
|
+
"-m, --model <model>": "Video model",
|
|
248
|
+
"-q, --quality <quality>": "Video quality",
|
|
249
|
+
"-d, --duration <seconds>": "Duration in seconds",
|
|
250
|
+
"--count <number>": "Number of generations",
|
|
251
|
+
"--seed <number>": "Random seed",
|
|
252
|
+
"--audio": "Enable audio generation",
|
|
253
|
+
"--no-audio": "Disable audio generation | negates: audio",
|
|
254
|
+
"--off-peak": "Use off-peak pricing",
|
|
255
|
+
"--idempotency-key <key>": "Idempotency key for safe retry - backend dedupes by key so repeated submissions return the original task without re-charging",
|
|
256
|
+
"--no-wait": "Return immediately without polling | negates: wait",
|
|
257
|
+
"--timeout <seconds>": "Polling timeout in seconds | default: 300",
|
|
258
|
+
"--json": "Output as JSON"
|
|
259
|
+
}
|
|
260
|
+
},
|
|
261
|
+
{
|
|
262
|
+
"cmd": "pixverse create modify",
|
|
263
|
+
"desc": "Modify an existing video",
|
|
264
|
+
"run": true,
|
|
265
|
+
"auth": true,
|
|
266
|
+
"effect": "creates_remote_media_asset",
|
|
267
|
+
"options": {
|
|
268
|
+
"--video <input>": "Video input: file path, HTTPS URL, video ID, or media path",
|
|
269
|
+
"--prompt <text>": "Prompt describing the modification. Reference uploaded images with @image1, @image2, ... (1-indexed, matches --images order)",
|
|
270
|
+
"--images <inputs...>": "Reference image inputs (max 5): file paths, HTTPS URLs, image IDs, or media paths. Reference them in --prompt as @image1, @image2, ...",
|
|
271
|
+
"--keyframe-time <ms>": "Keyframe time in milliseconds (0 = first frame) | default: 0",
|
|
272
|
+
"-m, --model <model>": "Video model",
|
|
273
|
+
"-q, --quality <quality>": "Video quality",
|
|
274
|
+
"--count <number>": "Number of generations",
|
|
275
|
+
"--seed <number>": "Random seed",
|
|
276
|
+
"--off-peak": "Use off-peak pricing",
|
|
277
|
+
"--idempotency-key <key>": "Idempotency key for safe retry - backend dedupes by key so repeated submissions return the original task without re-charging",
|
|
278
|
+
"--no-wait": "Return immediately without polling | negates: wait",
|
|
279
|
+
"--timeout <seconds>": "Polling timeout in seconds | default: 300",
|
|
280
|
+
"--json": "Output as JSON"
|
|
281
|
+
}
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
"cmd": "pixverse create upscale",
|
|
285
|
+
"desc": "Upscale video resolution",
|
|
286
|
+
"run": true,
|
|
287
|
+
"auth": true,
|
|
288
|
+
"effect": "creates_remote_media_asset",
|
|
289
|
+
"options": {
|
|
290
|
+
"--video <input>": "Video input: file path, HTTPS URL, video ID, or media path",
|
|
291
|
+
"-q, --quality <quality>": "Target quality (e.g. 1080p)",
|
|
292
|
+
"--idempotency-key <key>": "Idempotency key for safe retry - backend dedupes by key so repeated submissions return the original task without re-charging",
|
|
293
|
+
"--no-wait": "Return immediately without polling | negates: wait",
|
|
294
|
+
"--timeout <seconds>": "Polling timeout in seconds | default: 300",
|
|
295
|
+
"--json": "Output as JSON"
|
|
296
|
+
}
|
|
297
|
+
},
|
|
298
|
+
{
|
|
299
|
+
"cmd": "pixverse create reference",
|
|
300
|
+
"desc": "Multi-subject character fusion video",
|
|
301
|
+
"run": true,
|
|
302
|
+
"auth": true,
|
|
303
|
+
"effect": "creates_remote_media_asset",
|
|
304
|
+
"options": {
|
|
305
|
+
"--images <inputs...>": "Image inputs: file paths, HTTPS URLs, image IDs, or media paths (1–7; local oversized images are auto-resized to fit 1920x1920)",
|
|
306
|
+
"--videos <inputs...>": "Video reference inputs (seedance-2.0 only): file paths, HTTPS URLs, video IDs, or media paths (max 3, total duration ≤ 15s)",
|
|
307
|
+
"--prompt <text>": "Prompt text",
|
|
308
|
+
"-m, --model <model>": "Video model",
|
|
309
|
+
"-q, --quality <quality>": "Video quality",
|
|
310
|
+
"--aspect-ratio <ratio>": "Aspect ratio",
|
|
311
|
+
"-d, --duration <seconds>": "Duration in seconds",
|
|
312
|
+
"--count <number>": "Number of generations",
|
|
313
|
+
"--seed <number>": "Random seed",
|
|
314
|
+
"--audio": "Enable audio generation",
|
|
315
|
+
"--no-audio": "Disable audio generation | negates: audio",
|
|
316
|
+
"--off-peak": "Use off-peak pricing",
|
|
317
|
+
"--idempotency-key <key>": "Idempotency key for safe retry - backend dedupes by key so repeated submissions return the original task without re-charging",
|
|
318
|
+
"--no-wait": "Return immediately without polling | negates: wait",
|
|
319
|
+
"--timeout <seconds>": "Polling timeout in seconds | default: 300",
|
|
320
|
+
"--json": "Output as JSON"
|
|
321
|
+
}
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"cmd": "pixverse create motion-control",
|
|
325
|
+
"desc": "Generate video with character image + motion reference video",
|
|
326
|
+
"run": true,
|
|
327
|
+
"auth": true,
|
|
328
|
+
"effect": "creates_remote_media_asset",
|
|
329
|
+
"options": {
|
|
330
|
+
"--image <input>": "Character image: file path, HTTPS URL, image ID, or media path (required; local oversized images are auto-resized to fit 1920x1920)",
|
|
331
|
+
"--video <input>": "Motion reference video: file path, HTTPS URL, video ID, or media path (required)",
|
|
332
|
+
"-m, --model <model>": "Video model",
|
|
333
|
+
"-q, --quality <quality>": "Video quality",
|
|
334
|
+
"--count <number>": "Number of generations",
|
|
335
|
+
"--off-peak": "Use off-peak pricing",
|
|
336
|
+
"--idempotency-key <key>": "Idempotency key for safe retry - backend dedupes by key so repeated submissions return the original task without re-charging",
|
|
337
|
+
"--no-wait": "Return immediately without polling | negates: wait",
|
|
338
|
+
"--timeout <seconds>": "Polling timeout in seconds | default: 300",
|
|
339
|
+
"--json": "Output as JSON"
|
|
340
|
+
}
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"cmd": "pixverse create template",
|
|
344
|
+
"desc": "Create from a template/effect",
|
|
345
|
+
"run": true,
|
|
346
|
+
"auth": true,
|
|
347
|
+
"effect": "creates_remote_media_asset",
|
|
348
|
+
"options": {
|
|
349
|
+
"--template-id <id>": "Template ID (required)",
|
|
350
|
+
"--image <paths...>": "Image input(s): file paths, HTTPS URLs, image IDs, or media paths (local oversized images are auto-resized to fit 1920x1920)",
|
|
351
|
+
"--video <input>": "Video input: file path, HTTPS URL, video ID, or media path",
|
|
352
|
+
"--prompt <text>": "Prompt text (optional for some templates)",
|
|
353
|
+
"-q, --quality <quality>": "Video/image quality",
|
|
354
|
+
"-d, --duration <seconds>": "Duration in seconds",
|
|
355
|
+
"--aspect-ratio <ratio>": "Aspect ratio",
|
|
356
|
+
"--seed <number>": "Random seed",
|
|
357
|
+
"--count <number>": "Number of generations",
|
|
358
|
+
"--off-peak": "Use off-peak pricing",
|
|
359
|
+
"--idempotency-key <key>": "Idempotency key for safe retry - backend dedupes by key so repeated submissions return the original task without re-charging",
|
|
360
|
+
"--no-wait": "Return immediately without polling | negates: wait",
|
|
361
|
+
"--timeout <seconds>": "Polling timeout in seconds | default: 300",
|
|
362
|
+
"--json": "Output as JSON"
|
|
363
|
+
}
|
|
364
|
+
},
|
|
365
|
+
{
|
|
366
|
+
"cmd": "pixverse task",
|
|
367
|
+
"desc": "Manage generation tasks",
|
|
368
|
+
"children": [
|
|
369
|
+
"status",
|
|
370
|
+
"wait"
|
|
371
|
+
]
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
"cmd": "pixverse task status",
|
|
375
|
+
"desc": "Check the status of one or more generation tasks",
|
|
376
|
+
"run": true,
|
|
377
|
+
"auth": true,
|
|
378
|
+
"args": {
|
|
379
|
+
"id?": "Single video, image, or audio ID (omit when using --ids)"
|
|
380
|
+
},
|
|
381
|
+
"options": {
|
|
382
|
+
"--ids <ids>": "Comma-separated list of IDs for batch query (e.g. 123,456,789)",
|
|
383
|
+
"--type <type>": "Asset type: video, image, or audio | default: video",
|
|
384
|
+
"--json": "Output as JSON"
|
|
385
|
+
}
|
|
386
|
+
},
|
|
387
|
+
{
|
|
388
|
+
"cmd": "pixverse task wait",
|
|
389
|
+
"desc": "Wait for a generation task to complete",
|
|
390
|
+
"run": true,
|
|
391
|
+
"auth": true,
|
|
392
|
+
"args": {
|
|
393
|
+
"id": "Video, image, or audio ID"
|
|
394
|
+
},
|
|
395
|
+
"options": {
|
|
396
|
+
"--type <type>": "Asset type: video, image, or audio | default: video",
|
|
397
|
+
"--timeout <seconds>": "Timeout in seconds | default: 300",
|
|
398
|
+
"--json": "Output as JSON"
|
|
399
|
+
}
|
|
400
|
+
},
|
|
401
|
+
{
|
|
402
|
+
"cmd": "pixverse asset",
|
|
403
|
+
"desc": "Manage your generated assets",
|
|
404
|
+
"children": [
|
|
405
|
+
"list",
|
|
406
|
+
"info",
|
|
407
|
+
"download",
|
|
408
|
+
"upload",
|
|
409
|
+
"delete"
|
|
410
|
+
]
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"cmd": "pixverse asset list",
|
|
414
|
+
"desc": "List your generated assets",
|
|
415
|
+
"run": true,
|
|
416
|
+
"auth": true,
|
|
417
|
+
"options": {
|
|
418
|
+
"--type <type>": "Asset type: video, image, or audio | default: video | choices: video, image, audio",
|
|
419
|
+
"--source <source>": "Asset source: create or upload | default: create | choices: create, upload",
|
|
420
|
+
"--off-peak": "Filter off-peak generations only (video + create only)",
|
|
421
|
+
"--limit <number>": "Number of items per page | default: 20",
|
|
422
|
+
"--page <number>": "Page number | default: 1",
|
|
423
|
+
"--json": "Output as JSON"
|
|
424
|
+
}
|
|
425
|
+
},
|
|
426
|
+
{
|
|
427
|
+
"cmd": "pixverse asset info",
|
|
428
|
+
"desc": "Get details of a specific asset",
|
|
429
|
+
"run": true,
|
|
430
|
+
"auth": true,
|
|
431
|
+
"args": {
|
|
432
|
+
"id": "Video, image, or audio ID"
|
|
433
|
+
},
|
|
434
|
+
"options": {
|
|
435
|
+
"--type <type>": "Asset type: video, image, or audio (auto-detected if omitted)",
|
|
436
|
+
"--source <source>": "Audio source: create or upload | default: create | choices: create, upload",
|
|
437
|
+
"--json": "Output as JSON"
|
|
438
|
+
}
|
|
439
|
+
},
|
|
440
|
+
{
|
|
441
|
+
"cmd": "pixverse asset download",
|
|
442
|
+
"desc": "Download a created video, image, or audio to local disk",
|
|
443
|
+
"run": true,
|
|
444
|
+
"auth": true,
|
|
445
|
+
"args": {
|
|
446
|
+
"id": "Created video, image, or audio ID (uploads not downloadable)"
|
|
447
|
+
},
|
|
448
|
+
"options": {
|
|
449
|
+
"--type <type>": "Asset type: video, image, or audio (auto-detected if omitted)",
|
|
450
|
+
"--dest <path>": "Destination directory",
|
|
451
|
+
"--json": "Output as JSON"
|
|
452
|
+
}
|
|
453
|
+
},
|
|
454
|
+
{
|
|
455
|
+
"cmd": "pixverse asset upload",
|
|
456
|
+
"desc": "Upload a local file or HTTPS URL to asset library",
|
|
457
|
+
"run": true,
|
|
458
|
+
"auth": true,
|
|
459
|
+
"effect": "uploads_local_or_remote_file",
|
|
460
|
+
"args": {
|
|
461
|
+
"input": "Local file path or HTTPS URL (jpg/png/webp/mp4/mov/mp3/wav/m4a/aac/ogg)"
|
|
462
|
+
},
|
|
463
|
+
"options": {
|
|
464
|
+
"--json": "Output as JSON"
|
|
465
|
+
}
|
|
466
|
+
},
|
|
467
|
+
{
|
|
468
|
+
"cmd": "pixverse asset delete",
|
|
469
|
+
"desc": "Delete a video, image, or audio asset",
|
|
470
|
+
"run": true,
|
|
471
|
+
"auth": true,
|
|
472
|
+
"effect": "destructive_remote_or_local_change",
|
|
473
|
+
"destructive": true,
|
|
474
|
+
"args": {
|
|
475
|
+
"id": "Video, image, or audio ID"
|
|
476
|
+
},
|
|
477
|
+
"options": {
|
|
478
|
+
"--type <type>": "Asset type: video, image, or audio (auto-detected if omitted) | choices: video, image, audio",
|
|
479
|
+
"--source <source>": "Asset source: create or upload | default: create | choices: create, upload",
|
|
480
|
+
"--json": "Output as JSON"
|
|
481
|
+
}
|
|
482
|
+
},
|
|
483
|
+
{
|
|
484
|
+
"cmd": "pixverse account",
|
|
485
|
+
"desc": "View account info and credit usage",
|
|
486
|
+
"children": [
|
|
487
|
+
"info",
|
|
488
|
+
"usage",
|
|
489
|
+
"slots"
|
|
490
|
+
]
|
|
491
|
+
},
|
|
492
|
+
{
|
|
493
|
+
"cmd": "pixverse account info",
|
|
494
|
+
"desc": "Show account info, workspace, and credit balance",
|
|
495
|
+
"run": true,
|
|
496
|
+
"auth": true,
|
|
497
|
+
"options": {
|
|
498
|
+
"--json": "Output as JSON"
|
|
499
|
+
}
|
|
500
|
+
},
|
|
501
|
+
{
|
|
502
|
+
"cmd": "pixverse account usage",
|
|
503
|
+
"desc": "Show credit consumption records",
|
|
504
|
+
"run": true,
|
|
505
|
+
"auth": true,
|
|
506
|
+
"options": {
|
|
507
|
+
"--type <type>": "Filter: all, earned, used (personal only) | default: all",
|
|
508
|
+
"--limit <n>": "Number of records to show | default: 20",
|
|
509
|
+
"--page <n>": "Page number | default: 1",
|
|
510
|
+
"--json": "Output as JSON"
|
|
511
|
+
}
|
|
512
|
+
},
|
|
513
|
+
{
|
|
514
|
+
"cmd": "pixverse account slots",
|
|
515
|
+
"desc": "Show current concurrent generation slots (image / video)",
|
|
516
|
+
"run": true,
|
|
517
|
+
"auth": true,
|
|
518
|
+
"options": {
|
|
519
|
+
"--json": "Output as JSON"
|
|
520
|
+
}
|
|
521
|
+
},
|
|
522
|
+
{
|
|
523
|
+
"cmd": "pixverse subscribe",
|
|
524
|
+
"desc": "Open the PixVerse subscription page in your browser",
|
|
525
|
+
"run": true,
|
|
526
|
+
"auth": true,
|
|
527
|
+
"options": {
|
|
528
|
+
"--json": "Output as JSON"
|
|
529
|
+
}
|
|
530
|
+
},
|
|
531
|
+
{
|
|
532
|
+
"cmd": "pixverse config",
|
|
533
|
+
"desc": "Manage CLI configuration",
|
|
534
|
+
"children": [
|
|
535
|
+
"list",
|
|
536
|
+
"get",
|
|
537
|
+
"set",
|
|
538
|
+
"reset",
|
|
539
|
+
"path",
|
|
540
|
+
"defaults"
|
|
541
|
+
]
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
"cmd": "pixverse config list",
|
|
545
|
+
"desc": "List configuration values",
|
|
546
|
+
"run": true,
|
|
547
|
+
"options": {
|
|
548
|
+
"--json": "Output as JSON"
|
|
549
|
+
}
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
"cmd": "pixverse config get",
|
|
553
|
+
"desc": "Get a configuration value",
|
|
554
|
+
"run": true,
|
|
555
|
+
"args": {
|
|
556
|
+
"key": "required"
|
|
557
|
+
},
|
|
558
|
+
"options": {
|
|
559
|
+
"--json": "Output as JSON"
|
|
560
|
+
}
|
|
561
|
+
},
|
|
562
|
+
{
|
|
563
|
+
"cmd": "pixverse config set",
|
|
564
|
+
"desc": "Set a configuration value",
|
|
565
|
+
"run": true,
|
|
566
|
+
"effect": "mutates_cli_or_remote_state",
|
|
567
|
+
"args": {
|
|
568
|
+
"key": "required",
|
|
569
|
+
"value": "required"
|
|
570
|
+
},
|
|
571
|
+
"options": {
|
|
572
|
+
"--json": "Output as JSON"
|
|
573
|
+
}
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
"cmd": "pixverse config reset",
|
|
577
|
+
"desc": "Reset all configuration to defaults",
|
|
578
|
+
"run": true,
|
|
579
|
+
"options": {
|
|
580
|
+
"--json": "Output as JSON"
|
|
581
|
+
}
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
"cmd": "pixverse config path",
|
|
585
|
+
"desc": "Show configuration file path",
|
|
586
|
+
"run": true,
|
|
587
|
+
"options": {
|
|
588
|
+
"--json": "Output as JSON"
|
|
589
|
+
}
|
|
590
|
+
},
|
|
591
|
+
{
|
|
592
|
+
"cmd": "pixverse config defaults",
|
|
593
|
+
"desc": "Manage per-mode creation default parameters",
|
|
594
|
+
"run": true,
|
|
595
|
+
"children": [
|
|
596
|
+
"show",
|
|
597
|
+
"set",
|
|
598
|
+
"reset"
|
|
599
|
+
]
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
"cmd": "pixverse config defaults show",
|
|
603
|
+
"desc": "Show creation defaults (all modes or a specific mode)",
|
|
604
|
+
"run": true,
|
|
605
|
+
"args": {
|
|
606
|
+
"mode?": "optional"
|
|
607
|
+
},
|
|
608
|
+
"options": {
|
|
609
|
+
"--json": "Output as JSON"
|
|
610
|
+
}
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
"cmd": "pixverse config defaults set",
|
|
614
|
+
"desc": "Set a creation default value",
|
|
615
|
+
"run": true,
|
|
616
|
+
"effect": "mutates_cli_or_remote_state",
|
|
617
|
+
"args": {
|
|
618
|
+
"mode": "required",
|
|
619
|
+
"key": "required",
|
|
620
|
+
"value": "required"
|
|
621
|
+
},
|
|
622
|
+
"options": {
|
|
623
|
+
"--json": "Output as JSON"
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
"cmd": "pixverse config defaults reset",
|
|
628
|
+
"desc": "Reset creation defaults to built-in values",
|
|
629
|
+
"run": true,
|
|
630
|
+
"effect": "destructive_remote_or_local_change",
|
|
631
|
+
"destructive": true,
|
|
632
|
+
"args": {
|
|
633
|
+
"mode?": "optional"
|
|
634
|
+
},
|
|
635
|
+
"options": {
|
|
636
|
+
"--json": "Output as JSON"
|
|
637
|
+
}
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
"cmd": "pixverse template",
|
|
641
|
+
"desc": "Browse and manage templates",
|
|
642
|
+
"children": [
|
|
643
|
+
"categories",
|
|
644
|
+
"list",
|
|
645
|
+
"search",
|
|
646
|
+
"info"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
"cmd": "pixverse template categories",
|
|
651
|
+
"desc": "List template categories",
|
|
652
|
+
"run": true,
|
|
653
|
+
"auth": true,
|
|
654
|
+
"options": {
|
|
655
|
+
"--json": "Output as JSON"
|
|
656
|
+
}
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
"cmd": "pixverse template list",
|
|
660
|
+
"desc": "List templates",
|
|
661
|
+
"run": true,
|
|
662
|
+
"auth": true,
|
|
663
|
+
"options": {
|
|
664
|
+
"--category <id>": "Filter by category ID",
|
|
665
|
+
"--limit <number>": "Number of items per page | default: 20",
|
|
666
|
+
"--page <number>": "Page number | default: 1",
|
|
667
|
+
"--json": "Output as JSON"
|
|
668
|
+
}
|
|
669
|
+
},
|
|
670
|
+
{
|
|
671
|
+
"cmd": "pixverse template search",
|
|
672
|
+
"desc": "Search templates by keyword",
|
|
673
|
+
"run": true,
|
|
674
|
+
"auth": true,
|
|
675
|
+
"args": {
|
|
676
|
+
"query": "Search keyword"
|
|
677
|
+
},
|
|
678
|
+
"options": {
|
|
679
|
+
"--json": "Output as JSON"
|
|
680
|
+
}
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"cmd": "pixverse template info",
|
|
684
|
+
"desc": "Get template details",
|
|
685
|
+
"run": true,
|
|
686
|
+
"auth": true,
|
|
687
|
+
"args": {
|
|
688
|
+
"id": "Template ID"
|
|
689
|
+
},
|
|
690
|
+
"options": {
|
|
691
|
+
"--json": "Output as JSON"
|
|
692
|
+
}
|
|
693
|
+
},
|
|
694
|
+
{
|
|
695
|
+
"cmd": "pixverse voice",
|
|
696
|
+
"desc": "Browse voice/TTS models and preset voices",
|
|
697
|
+
"children": [
|
|
698
|
+
"models",
|
|
699
|
+
"presets"
|
|
700
|
+
]
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
"cmd": "pixverse voice models",
|
|
704
|
+
"desc": "List available voice providers, models, and languages",
|
|
705
|
+
"run": true,
|
|
706
|
+
"auth": true,
|
|
707
|
+
"options": {
|
|
708
|
+
"--json": "Output as JSON"
|
|
709
|
+
}
|
|
710
|
+
},
|
|
711
|
+
{
|
|
712
|
+
"cmd": "pixverse voice presets",
|
|
713
|
+
"desc": "List preset voices",
|
|
714
|
+
"run": true,
|
|
715
|
+
"auth": true,
|
|
716
|
+
"options": {
|
|
717
|
+
"--model <id>": "Filter by model id",
|
|
718
|
+
"--language <code>": "Filter by language code",
|
|
719
|
+
"--provider <name>": "Filter by provider (minimax|elevenlabs)",
|
|
720
|
+
"--page <number>": "Page number | default: 1",
|
|
721
|
+
"--page-size <number>": "Items per page (max 10) | default: 10",
|
|
722
|
+
"--json": "Output as JSON"
|
|
723
|
+
}
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
"cmd": "pixverse music",
|
|
727
|
+
"desc": "Browse music generation models",
|
|
728
|
+
"children": [
|
|
729
|
+
"models"
|
|
730
|
+
]
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
"cmd": "pixverse music models",
|
|
734
|
+
"desc": "List available music providers and models",
|
|
735
|
+
"run": true,
|
|
736
|
+
"auth": true,
|
|
737
|
+
"options": {
|
|
738
|
+
"--json": "Output as JSON"
|
|
739
|
+
}
|
|
740
|
+
},
|
|
741
|
+
{
|
|
742
|
+
"cmd": "pixverse saved",
|
|
743
|
+
"desc": "Manage saved folders and their contents",
|
|
744
|
+
"children": [
|
|
745
|
+
"list",
|
|
746
|
+
"items",
|
|
747
|
+
"new",
|
|
748
|
+
"rename",
|
|
749
|
+
"add",
|
|
750
|
+
"remove",
|
|
751
|
+
"delete"
|
|
752
|
+
]
|
|
753
|
+
},
|
|
754
|
+
{
|
|
755
|
+
"cmd": "pixverse saved list",
|
|
756
|
+
"desc": "List your saved folders",
|
|
757
|
+
"run": true,
|
|
758
|
+
"auth": true,
|
|
759
|
+
"options": {
|
|
760
|
+
"--json": "Output as JSON"
|
|
761
|
+
}
|
|
762
|
+
},
|
|
763
|
+
{
|
|
764
|
+
"cmd": "pixverse saved items",
|
|
765
|
+
"desc": "List items in a saved folder",
|
|
766
|
+
"run": true,
|
|
767
|
+
"auth": true,
|
|
768
|
+
"args": {
|
|
769
|
+
"folder_id?": "Folder ID (default: default folder) | default: default"
|
|
770
|
+
},
|
|
771
|
+
"options": {
|
|
772
|
+
"--type <type>": "Asset type: all, video, or image | default: all | choices: all, video, image",
|
|
773
|
+
"--source <source>": "Asset source: create or upload | default: create | choices: create, upload",
|
|
774
|
+
"--limit <number>": "Number of items per page | default: 20",
|
|
775
|
+
"--page <number>": "Page number | default: 1",
|
|
776
|
+
"--json": "Output as JSON"
|
|
777
|
+
}
|
|
778
|
+
},
|
|
779
|
+
{
|
|
780
|
+
"cmd": "pixverse saved new",
|
|
781
|
+
"desc": "Create a new saved folder",
|
|
782
|
+
"run": true,
|
|
783
|
+
"auth": true,
|
|
784
|
+
"effect": "mutates_cli_or_remote_state",
|
|
785
|
+
"args": {
|
|
786
|
+
"name": "Folder name"
|
|
787
|
+
},
|
|
788
|
+
"options": {
|
|
789
|
+
"--json": "Output as JSON"
|
|
790
|
+
}
|
|
791
|
+
},
|
|
792
|
+
{
|
|
793
|
+
"cmd": "pixverse saved rename",
|
|
794
|
+
"desc": "Rename a saved folder",
|
|
795
|
+
"run": true,
|
|
796
|
+
"auth": true,
|
|
797
|
+
"effect": "mutates_cli_or_remote_state",
|
|
798
|
+
"args": {
|
|
799
|
+
"folder_id": "Folder ID",
|
|
800
|
+
"name": "New folder name"
|
|
801
|
+
},
|
|
802
|
+
"options": {
|
|
803
|
+
"--json": "Output as JSON"
|
|
804
|
+
}
|
|
805
|
+
},
|
|
806
|
+
{
|
|
807
|
+
"cmd": "pixverse saved add",
|
|
808
|
+
"desc": "Add assets to a saved folder",
|
|
809
|
+
"run": true,
|
|
810
|
+
"auth": true,
|
|
811
|
+
"effect": "mutates_cli_or_remote_state",
|
|
812
|
+
"args": {
|
|
813
|
+
"ids...": "Asset IDs to add"
|
|
814
|
+
},
|
|
815
|
+
"options": {
|
|
816
|
+
"--folder <folder_id>": "Folder ID (default: default folder) | default: default",
|
|
817
|
+
"--type <type>": "Asset type: video or image | choices: video, image",
|
|
818
|
+
"--source <source>": "Asset source: create or upload | default: create | choices: create, upload",
|
|
819
|
+
"--json": "Output as JSON"
|
|
820
|
+
}
|
|
821
|
+
},
|
|
822
|
+
{
|
|
823
|
+
"cmd": "pixverse saved remove",
|
|
824
|
+
"desc": "Remove assets from a saved folder",
|
|
825
|
+
"run": true,
|
|
826
|
+
"auth": true,
|
|
827
|
+
"effect": "destructive_remote_or_local_change",
|
|
828
|
+
"destructive": true,
|
|
829
|
+
"args": {
|
|
830
|
+
"ids...": "Asset IDs to remove"
|
|
831
|
+
},
|
|
832
|
+
"options": {
|
|
833
|
+
"--folder <folder_id>": "Folder ID (default: default folder) | default: default",
|
|
834
|
+
"--type <type>": "Asset type: video or image | choices: video, image",
|
|
835
|
+
"--source <source>": "Asset source: create or upload | default: create | choices: create, upload",
|
|
836
|
+
"--json": "Output as JSON"
|
|
837
|
+
}
|
|
838
|
+
},
|
|
839
|
+
{
|
|
840
|
+
"cmd": "pixverse saved delete",
|
|
841
|
+
"desc": "Delete a saved folder",
|
|
842
|
+
"run": true,
|
|
843
|
+
"auth": true,
|
|
844
|
+
"effect": "destructive_remote_or_local_change",
|
|
845
|
+
"destructive": true,
|
|
846
|
+
"args": {
|
|
847
|
+
"folder_id": "Folder ID"
|
|
848
|
+
},
|
|
849
|
+
"options": {
|
|
850
|
+
"--json": "Output as JSON"
|
|
851
|
+
}
|
|
852
|
+
},
|
|
853
|
+
{
|
|
854
|
+
"cmd": "pixverse workspace",
|
|
855
|
+
"desc": "Manage workspaces (list, switch, view current)",
|
|
856
|
+
"children": [
|
|
857
|
+
"list",
|
|
858
|
+
"status",
|
|
859
|
+
"switch",
|
|
860
|
+
"manage"
|
|
861
|
+
]
|
|
862
|
+
},
|
|
863
|
+
{
|
|
864
|
+
"cmd": "pixverse workspace list",
|
|
865
|
+
"desc": "List all workspaces",
|
|
866
|
+
"run": true,
|
|
867
|
+
"auth": true,
|
|
868
|
+
"options": {
|
|
869
|
+
"--json": "Output as JSON"
|
|
870
|
+
}
|
|
871
|
+
},
|
|
872
|
+
{
|
|
873
|
+
"cmd": "pixverse workspace status",
|
|
874
|
+
"desc": "Show the currently active workspace",
|
|
875
|
+
"run": true,
|
|
876
|
+
"auth": true,
|
|
877
|
+
"options": {
|
|
878
|
+
"--json": "Output as JSON"
|
|
879
|
+
}
|
|
880
|
+
},
|
|
881
|
+
{
|
|
882
|
+
"cmd": "pixverse workspace switch",
|
|
883
|
+
"desc": "Switch to a different workspace (interactive if ID omitted)",
|
|
884
|
+
"run": true,
|
|
885
|
+
"auth": true,
|
|
886
|
+
"effect": "mutates_cli_or_remote_state",
|
|
887
|
+
"args": {
|
|
888
|
+
"workspace-id?": "optional"
|
|
889
|
+
},
|
|
890
|
+
"options": {
|
|
891
|
+
"--json": "Output as JSON"
|
|
892
|
+
}
|
|
893
|
+
},
|
|
894
|
+
{
|
|
895
|
+
"cmd": "pixverse workspace manage",
|
|
896
|
+
"desc": "Open workspace management page in your browser",
|
|
897
|
+
"run": true,
|
|
898
|
+
"auth": true,
|
|
899
|
+
"options": {
|
|
900
|
+
"--json": "Output as JSON"
|
|
901
|
+
}
|
|
902
|
+
},
|
|
903
|
+
{
|
|
904
|
+
"cmd": "pixverse update",
|
|
905
|
+
"desc": "Update the CLI to the latest version (npm i -g pixverse@latest)",
|
|
906
|
+
"run": true,
|
|
907
|
+
"effect": "updates_local_cli_installation",
|
|
908
|
+
"options": {
|
|
909
|
+
"--json": "Output as JSON"
|
|
910
|
+
}
|
|
911
|
+
}
|
|
912
|
+
]
|
|
913
|
+
}
|