PixVerse CLI

https://pixverse.ai/en/api/
Admin
PixVerse CLI is a command-line interface for generating AI videos and images directly from the...
Tokens:3,957
Snippets:53
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install PixVerse CLI Globally

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Install the PixVerse CLI globally using npm. This command makes the `pixverse` command available system-wide.

```bash
npm install -g pixverse
```

--------------------------------

### Batch Video Generation with Parallel Jobs

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

This example shows how to check available credits and then submit multiple video generation jobs in parallel using the `--no-wait` flag and shell backgrounding (`&`). Output JSON files are redirected to `/tmp/`.

```bash
# Check credits first
CREDITS=$(pixverse account info --json | jq -r '.credits.total')
echo "Available credits: $CREDITS"
 
# Submit four parallel generations
pixverse create video --prompt "Sunrise over mountains" --no-wait --json > /tmp/v1.json &
pixverse create video --prompt "Sunset over ocean" --no-wait --json > /tmp/v2.json &
pixverse create video --prompt "Stars over a desert" --no-wait --json > /tmp/v3.json &
pixverse create video --prompt "Aurora over a frozen lake" --no-wait --json > /tmp/v4.json &
wait

```

--------------------------------

### Verify PixVerse CLI Installation

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Check if the PixVerse CLI has been installed correctly by running the version command. This confirms the installation was successful.

```bash
pixverse --version
```

--------------------------------

### Add PixVerse Skills for AI Agents

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Install the PixVerse Skills library to enable AI agents to generate images and videos using the CLI. This command adds the core image and video generator skills.

```bash
npx skills add https://github.com/pixverseai/skills --skill pixverse-ai-image-and-video-generator
```

--------------------------------

### Example JSON Output for Image Generation

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

This is an example of the structured JSON output returned by the PixVerse CLI when generating an image with the `--json` flag.

```json
{
  "image_id": 789012,
  "status": "completed",
  "image_url": "https://...",
  "prompt": "A photorealistic forest path at golden hour",
  "model": "qwen-image",
  "width": 1024,
  "height": 1024
}
```

--------------------------------

### Run PixVerse CLI Commands with npx

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Execute PixVerse CLI commands without global installation using npx. This is useful for testing or running commands occasionally.

```bash
npx pixverse create video --prompt "A cat walking on Mars"
```

--------------------------------

### Claude Code: Autonomous Media Generation

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

This example shows how Claude Code can autonomously generate an image based on a prompt, specifying model, quality, aspect ratio, and download path. Claude Code handles the CLI invocation and file download.

```bash
Generate a cover image for this blog post about machine learning,
use the seedream-5.0-lite model at 1800p in 16:9 format,
download it to ./assets/cover.webp

```

--------------------------------

### Install Mondo Poster Design Skill

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Add the specialized Mondo Poster Design skill to your AI agent's capabilities. This skill allows for generating stylized movie posters and animations.

```bash
npx skills add https://github.com/pixverseai/skills --skill mondo-poster-design
```

--------------------------------

### Update PixVerse CLI

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Update the PixVerse CLI to the latest version using npm. This command fetches and installs the newest release of the package.

```bash
npm update -g pixverse
```

--------------------------------

### Launch PixVerse CLI Interactive Wizard

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Run the 'create video' or 'create image' command without arguments to launch an interactive wizard. This is useful for discovering available parameters and options step by step.

```bash
pixverse create video
```

```bash
pixverse create image
```

--------------------------------

### Full Video Production Pipeline

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

This comprehensive pipeline demonstrates chaining multiple PixVerse CLI commands to create a video, extend its duration, add ambient sound, upscale its quality, and finally download the polished output. It includes waiting for tasks to complete.

```bash
# Step 1: Create the base video
RESULT=$(pixverse create video \
  --prompt "A product being assembled in slow motion" \
  --model v6 \
  --quality 720p \
  --duration 5 \
  --json)
 
VID=$(echo "$RESULT" | jq -r '.video_id')
 
# Step 2: Extend duration
EXTENDED=$(pixverse create extend \
  --video "$VID" \
  --prompt "Continue the assembly sequence" \
  --duration 5 \
  --json | jq -r '.video_id')
 
pixverse task wait "$EXTENDED" --json
 
# Step 3: Add ambient sound
WITH_SOUND=$(pixverse create sound \
  --video "$EXTENDED" \
  --prompt "Industrial workshop ambience, soft mechanical sounds" \
  --json | jq -r '.video_id')
 
pixverse task wait "$WITH_SOUND" --json
 
# Step 4: Upscale to 1080p
FINAL=$(pixverse create upscale \
  --video "$WITH_SOUND" \
  --quality 1080p \
  --json | jq -r '.video_id')
 
pixverse task wait "$FINAL" --json
 
# Step 5: Download
pixverse asset download "$FINAL" --json

```

--------------------------------

### Configure PixVerse CLI Defaults

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Set default configurations for video and image generation to avoid repeating flags. This includes specifying the mode, model, quality, and aspect ratio for video, and model, quality for images. It also shows how to set the default output directory.

```bash
pixverse config defaults set --mode video --model v6 --quality 1080p --aspect-ratio 16:9
```

```bash
pixverse config defaults set --mode image --model seedream-5.0-lite --quality 1800p
```

```bash
pixverse config set output-dir ~/Downloads/pixverse
```

--------------------------------

### Generate First AI Video

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Create your first AI-generated video by providing a prompt. The `--json` flag outputs the result in JSON format.

```bash
pixverse create video --prompt "..." --json
```

--------------------------------

### Text to Image to Video Pipeline

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

This multi-step pipeline first generates a base image from a text prompt, then animates that image into a video, and finally downloads the resulting video. It uses `jq` to extract URLs and IDs from JSON responses.

```bash
# Step 1: Generate a base image
IMG_RESULT=$(pixverse create image \
  --prompt "A cyberpunk cityscape at night, neon lights reflecting on wet pavement" \
  --model gemini-3.1-flash \
  --quality 2160p \
  --aspect-ratio 16:9 \
  --json)
 
IMAGE_URL=$(echo "$IMG_RESULT" | jq -r '.image_url')
 
# Step 2: Animate it into a video
VID_RESULT=$(pixverse create video \
  --prompt "Camera slowly pans across the neon-lit streets" \
  --image "$IMAGE_URL" \
  --model v6 \
  --quality 1080p \
  --duration 8 \
  --json)
 
VIDEO_ID=$(echo "$VID_RESULT" | jq -r '.video_id')
 
# Step 3: Download the final video
pixverse asset download "$VIDEO_ID" --json

```

--------------------------------

### Animate a Static Image with PixVerse CLI

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Turn a local image file or URL into a video by providing the --image flag along with a prompt and other video generation parameters.

```bash
pixverse create video \
  --prompt "Gentle wind moves through the scene" \
  --image ./product-photo.jpg \
  --model v6 \
  --quality 1080p \
  --json
```

--------------------------------

### Generate a 5-Second Video with PixVerse CLI

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Use this command to quickly generate a short video clip from a text prompt. The --json flag outputs a video URL upon completion.

```bash
pixverse create video --prompt "A sunset over ocean waves" --json
```

--------------------------------

### Generate First AI Image with JSON Output

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Create your first AI image using a text prompt. The `--json` flag provides structured output, useful for scripting and automation.

```bash
pixverse create image --prompt "A photorealistic forest path at golden hour" --json
```

--------------------------------

### Advanced Video Generation with PixVerse CLI

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Create a customized video with specific models, quality, aspect ratio, and duration. The --audio flag adds AI-generated ambient sound.

```bash
pixverse create video \
  --prompt "A cinematic drone shot over a misty mountain valley at dawn" \
  --model v6 \
  --quality 1080p \
  --aspect-ratio 16:9 \
  --duration 8 \
  --audio \
  --json
```

--------------------------------

### Generate First AI Image

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Create your first AI-generated image by providing a prompt. The `--json` flag outputs the result in JSON format.

```bash
pixverse create image --prompt "..." --json
```

--------------------------------

### Loop Through JSON Files, Wait for Task, and Download

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

This script iterates through a list of JSON files, extracts a video ID from each, waits for the corresponding PixVerse task to complete, and then downloads the generated asset. It's useful for batch processing where each file represents a separate generation job.

```bash
for f in /tmp/v1.json /tmp/v2.json /tmp/v3.json /tmp/v4.json; do
  ID=$(jq -r '.video_id' "$f")
  pixverse task wait "$ID" --json
  pixverse asset download "$ID" --json
done
```

--------------------------------

### Verify Account Information and Credits

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Check your PixVerse account details and available credits to ensure your account is set up correctly.

```bash
pixverse account info
```

--------------------------------

### Claude Code: Image Generation and Animation Workflow

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

This workflow demonstrates how Claude Code can first generate an image using the PixVerse CLI and then animate it into a video, capturing the image URL for subsequent use. It utilizes `jq` for parsing JSON output.

```bash
# Claude Code runs this autonomously based on your instruction
IMG=$(pixverse create image \
  --prompt "Abstract visualization of neural network layers, dark background, blue and purple tones" \
  --model seedream-5.0-lite \
  --quality 1800p \
  --aspect-ratio 16:9 \
  --json | jq -r '.image_url')
 
# Then animates it
pixverse create video \
  --prompt "Slow pan across glowing neural connections" \
  --image "$IMG" \
  --model v6 \
  --quality 1080p \
  --duration 6 \
  --json

```

--------------------------------

### Authenticate PixVerse CLI

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Log in to your PixVerse account via the CLI. This initiates a browser-based OAuth flow to securely authenticate your session.

```bash
pixverse auth login
```

--------------------------------

### Check PixVerse CLI Authentication Status

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Verify your current authentication status and view account details, including subscription tier and remaining credits. It's recommended to check your balance before running batch jobs.

```bash
pixverse auth status
```

```bash
pixverse account info
```

--------------------------------

### Generate High-Resolution AI Image

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Generate a high-resolution AI image by specifying a model, quality, and aspect ratio. This command demonstrates advanced image generation options.

```bash
pixverse create image \
  --prompt "A photorealistic forest path at golden hour" \
  --model seedream-5.0-lite \
  --quality 1800p \
  --aspect-ratio 16:9 \
  --json
```

--------------------------------

### Download Generated Image Asset

Source: https://pixverse.ai/en/blog/pixverse-cli-generate-ai-videos-images-from-terminal

Download a previously generated image asset using its unique ID. This command retrieves the media file from PixVerse servers.

```bash
pixverse asset download 789012
```
Tokens:
Raw