PicX CLI

Images and video from the terminal — or from any AI agent that can run a shell command. Every command speaks --json.

Install and sign in

Install (Node 20+)

npm i -g picx-cli

Use your API key

export PICX_API_KEY=pxsk_YOUR_KEY
picx whoami

Create a key on the API keys page. See live model prices with picx models. Package: picx-cli on npm.

AI Agent Ready
Structured --json output on every command, plus a built-in MCP install/doctor flow for Claude Desktop and Cursor.
Generate Images
Text-to-image with PicX's multi-model lineup — headshots, product shots, social content.
Edit Images
AI-powered editing across 1-5 source images at once — backgrounds, lighting, style transfer.
Generate Video
Text, image, or reference-driven video generation with async job polling via picx job.
Any Resolution
1K, 2K, or 4K with flexible aspect ratios: 1:1, 16:9, 9:16, 4:3, 3:2.
REST API + CLI + MCP
Use the CLI from a terminal, the REST API from any language, or hand the same account to an MCP-connected agent.

Commands

picx image <prompt>
Generate an image from a text prompt
```
picx image "a sunset over mountains, oil painting style"
```

picx image edit <instruction> --image-urls <urls>

Edit one or more existing images with an AI instruction

picx image edit "make it nighttime with city lights" \
  --image-urls https://cdn.picxstudio.com/api/generated/image.png

picx video <prompt>
Generate a video from a text prompt (text/image/reference mode)
```
picx video "a drone shot flying over a coastline"
```
picx job <id>
Poll a generation job's status and get the result URL when done
```
picx job gen_abc123
```
picx upload <file>
Upload a local file to get an HTTPS URL for edit/video input
```
picx upload ./photo.jpg
```
picx assets list
List uploaded and generated assets in your account
```
picx assets list
```
picx assets rm <id>
Delete an asset by id
```
picx assets rm asset_abc123
```
picx models
List available models and their live credit costs
```
picx models
```
picx templates search <query>
Search the PicX template library
```
picx templates search "product photography"
```
picx templates get <id>
Get a single template by id
```
picx templates get tpl_abc123
```
picx history
List your past generations, paginated
```
picx history
```
picx whoami
Check API key authentication status and account identity
```
picx whoami
```
picx balance
Show current credit balance
```
picx balance
```
picx usage
Show API usage statistics
```
picx usage
```
picx tier
Show your account's current plan/tier
```
picx tier
```
picx mcp install --client <claude|cursor>
Install and configure the PicX MCP server for an MCP client
```
picx mcp install --client claude
```
picx mcp doctor
Health-check the MCP connection and credentials
```
picx mcp doctor
```

Use it from an AI agent

Claude Desktop · by Anthropic

Install the PicX MCP server directly from the CLI, then generate images and video by asking Claude in plain language — it calls the tools itself.

One-time setup

npm i -g picx-cli
export PICX_API_KEY=pxsk_YOUR_KEY
picx mcp install --client claude
picx mcp doctor

Cursor · AI code editor

Same install path — Cursor picks up the PicX tools the next time it starts, no extra config beyond the API key.

One-time setup

npm i -g picx-cli
export PICX_API_KEY=pxsk_YOUR_KEY
picx mcp install --client cursor
picx mcp doctor

Prefer connecting the agent directly? See the MCP server.

Recipes

Social Media Content

Instagram posts, YouTube thumbnails, Twitter banners — any size, any style.

# Instagram post (square)
picx image "minimal flat-lay coffee, aesthetic" \
  --aspect-ratio 1:1

# YouTube thumbnail (wide)
picx image "bold dramatic thumbnail" \
  --aspect-ratio 16:9 --size 2K

# Instagram story (vertical)
picx image "behind the scenes shot" \
  --aspect-ratio 9:16

Edit & Transform

Change backgrounds, seasons, styles, or fix lighting on any image.

# Upload then edit
picx upload ./selfie.jpg
picx image edit "white studio backdrop, enhance" \
  --image-urls <uploaded-url>

# Style transfer
picx image edit "anime art style, vibrant" \
  --image-urls <uploaded-url> --size 2K

# Batch: upload + edit a folder
for f in ./photos/*.jpg; do
  url=$(picx upload "$f" --json | jq -r .url)
  picx image edit "vintage film grain" --image-urls "$url"
done

Full reference in the CLI docs.

Commands

picx image <prompt>

Generate an image from a text prompt

picx image "a sunset over mountains, oil painting style"

picx image edit <instruction> --image-urls <urls>

Edit one or more existing images with an AI instruction

picx image edit "make it nighttime with city lights" \
  --image-urls https://cdn.picxstudio.com/api/generated/image.png

picx video <prompt>

Generate a video from a text prompt (text/image/reference mode)

picx video "a drone shot flying over a coastline"

picx job <id>

Poll a generation job's status and get the result URL when done

picx job gen_abc123

picx upload <file>

Upload a local file to get an HTTPS URL for edit/video input

picx upload ./photo.jpg

picx assets list

List uploaded and generated assets in your account

picx assets list

picx assets rm <id>

Delete an asset by id

picx assets rm asset_abc123

picx models

List available models and their live credit costs

picx models

picx templates search <query>

Search the PicX template library

picx templates search "product photography"

picx templates get <id>

Get a single template by id

picx templates get tpl_abc123

picx history

List your past generations, paginated

picx history

picx whoami

Check API key authentication status and account identity

picx whoami

picx balance

Show current credit balance

picx balance

picx usage

Show API usage statistics

picx usage

picx tier

Show your account's current plan/tier

picx tier

picx mcp install --client <claude|cursor>

Install and configure the PicX MCP server for an MCP client

picx mcp install --client claude

picx mcp doctor

Health-check the MCP connection and credentials

picx mcp doctor

Use it from an AI agent

Claude Desktop · by Anthropic

Install the PicX MCP server directly from the CLI, then generate images and video by asking Claude in plain language — it calls the tools itself.

One-time setup

npm i -g picx-cli
export PICX_API_KEY=pxsk_YOUR_KEY
picx mcp install --client claude
picx mcp doctor

Cursor · AI code editor

Same install path — Cursor picks up the PicX tools the next time it starts, no extra config beyond the API key.

One-time setup

npm i -g picx-cli
export PICX_API_KEY=pxsk_YOUR_KEY
picx mcp install --client cursor
picx mcp doctor

Prefer connecting the agent directly? See the MCP server.

Recipes

Social Media Content

Instagram posts, YouTube thumbnails, Twitter banners — any size, any style.

# Instagram post (square)
picx image "minimal flat-lay coffee, aesthetic" \
  --aspect-ratio 1:1

# YouTube thumbnail (wide)
picx image "bold dramatic thumbnail" \
  --aspect-ratio 16:9 --size 2K

# Instagram story (vertical)
picx image "behind the scenes shot" \
  --aspect-ratio 9:16

Edit & Transform

Change backgrounds, seasons, styles, or fix lighting on any image.

# Upload then edit
picx upload ./selfie.jpg
picx image edit "white studio backdrop, enhance" \
  --image-urls <uploaded-url>

# Style transfer
picx image edit "anime art style, vibrant" \
  --image-urls <uploaded-url> --size 2K

# Batch: upload + edit a folder
for f in ./photos/*.jpg; do
  url=$(picx upload "$f" --json | jq -r .url)
  picx image edit "vintage film grain" --image-urls "$url"
done

Full reference in the CLI docs.

Install and sign in

What it does

Commands

Use it from an AI agent

Recipes

Install and sign in

What it does

Commands

Use it from an AI agent

Recipes