pixverse-cli 1.0.0 → 1.0.2
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 +38 -4
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@ The official command-line interface (CLI) for [PixVerse](https://pixverse.ai)
|
|
|
4
4
|
|
|
5
5
|
## What is PixVerse?
|
|
6
6
|
|
|
7
|
-
PixVerse is an AI-powered creative platform that generates high-quality videos and images from text prompts or reference images. It supports a wide range of creative workflows including text-to-video, image-to-video, text-to-image, video transitions, lip-sync speech, sound effects, and more.
|
|
7
|
+
PixVerse is an AI-powered creative platform that generates high-quality videos and images from text prompts or reference images. It supports a wide range of creative workflows including text-to-video, image-to-video, text-to-image, video transitions, lip-sync speech, sound effects, templates/effects, and more.
|
|
8
8
|
|
|
9
9
|
## What is PixVerse CLI?
|
|
10
10
|
|
|
@@ -109,6 +109,9 @@ pixverse create upscale --video <video_id> --quality 1080p
|
|
|
109
109
|
|
|
110
110
|
# Generate video with character reference (requires 2+ images)
|
|
111
111
|
pixverse create reference --images ./char1.png ./char2.png --prompt "Two friends walking in a park"
|
|
112
|
+
|
|
113
|
+
# Create from a template/effect
|
|
114
|
+
pixverse create template --template-id 12345 --image ./photo.png
|
|
112
115
|
```
|
|
113
116
|
|
|
114
117
|
### Task Management
|
|
@@ -137,6 +140,23 @@ pixverse asset download <id>
|
|
|
137
140
|
pixverse asset delete <id>
|
|
138
141
|
```
|
|
139
142
|
|
|
143
|
+
### Templates
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
# List template categories
|
|
147
|
+
pixverse template categories
|
|
148
|
+
|
|
149
|
+
# List templates (with optional category filter and pagination)
|
|
150
|
+
pixverse template list
|
|
151
|
+
pixverse template list --category 5 --page 2 --limit 10
|
|
152
|
+
|
|
153
|
+
# Search templates by keyword
|
|
154
|
+
pixverse template search "dance"
|
|
155
|
+
|
|
156
|
+
# Get template details
|
|
157
|
+
pixverse template info <template_id>
|
|
158
|
+
```
|
|
159
|
+
|
|
140
160
|
### Account & Subscription
|
|
141
161
|
|
|
142
162
|
```bash
|
|
@@ -151,12 +171,19 @@ pixverse subscribe
|
|
|
151
171
|
### Configuration
|
|
152
172
|
|
|
153
173
|
```bash
|
|
154
|
-
# Set
|
|
155
|
-
pixverse config set default-model v5.6
|
|
174
|
+
# Set output directory
|
|
156
175
|
pixverse config set output-dir ~/Downloads
|
|
157
176
|
|
|
158
177
|
# View current configuration
|
|
159
178
|
pixverse config list
|
|
179
|
+
|
|
180
|
+
# Show config file path
|
|
181
|
+
pixverse config path
|
|
182
|
+
|
|
183
|
+
# Set per-mode creation defaults (model, quality, duration, etc.)
|
|
184
|
+
pixverse config defaults set video model v5.6
|
|
185
|
+
pixverse config defaults set video quality 1080p
|
|
186
|
+
pixverse config defaults show
|
|
160
187
|
```
|
|
161
188
|
|
|
162
189
|
## JSON Output for Scripts & Agents
|
|
@@ -204,7 +231,12 @@ pixverse asset download "$VID" --dest ./output/
|
|
|
204
231
|
| `create sound` | Add AI sound effects to video |
|
|
205
232
|
| `create extend` | Extend video duration |
|
|
206
233
|
| `create upscale` | Upscale video resolution |
|
|
207
|
-
| `create reference` | Generate video with
|
|
234
|
+
| `create reference` | Generate video with character references |
|
|
235
|
+
| `create template` | Create from a template/effect |
|
|
236
|
+
| `template categories` | List template categories |
|
|
237
|
+
| `template list` | List templates (with category filter) |
|
|
238
|
+
| `template search` | Search templates by keyword |
|
|
239
|
+
| `template info` | Get template details |
|
|
208
240
|
| `task status` | Check task status |
|
|
209
241
|
| `task wait` | Wait for task completion |
|
|
210
242
|
| `asset list` | List generated assets |
|
|
@@ -218,6 +250,8 @@ pixverse asset download "$VID" --dest ./output/
|
|
|
218
250
|
| `config get` | Get a config value |
|
|
219
251
|
| `config list` | List all config values |
|
|
220
252
|
| `config reset` | Reset config to defaults |
|
|
253
|
+
| `config path` | Show config file path |
|
|
254
|
+
| `config defaults` | Manage per-mode creation defaults |
|
|
221
255
|
|
|
222
256
|
## Global Flags
|
|
223
257
|
|