CLI cheatsheet

Authoritative parameter tables live in the binary itself: run cutcli <command> --help. This page is a curated quick reference.

Global options

cutcli [global options] <command> [subcommand options]

Option	Notes
--env-file <path>	Load a specific .env
--pretty	Pretty-print JSON output
-V, --version	Print version
-h, --help	Print help

Commands by category

Cloud authentication

Cloud upload/rendering commands need a cutcli.com API key. You can save it locally once with cutcli auth set, or provide it per process with CUTCLI_API_KEY.

Command	Purpose
cutcli auth set --api-key <key> [--api-base <url>]	Save the cloud API key
cutcli auth whoami	Show the account attached to the current API key
cutcli auth clear	Remove the locally saved API key

Draft management

Command	Purpose
cutcli draft create [--width N] [--height N]	Create a draft
cutcli draft list	List all drafts
cutcli draft info <draftId>	Show info for a draft
cutcli draft easy <draftId> --audio-url <url>	Auto-fit assets to the audio length
cutcli draft zip <draftId> [--output <path>]	Zip the draft
cutcli draft upload <draftId>	Zip + upload, returns a download URL

Cloud rendering

Command	Purpose
cutcli cloud render <draftId> [--zip <path>]	Upload a draft zip and create a cloud render job
cutcli cloud jobs [--status <status>]	List cloud render jobs, optionally filtered by status
cutcli cloud job <jobId>	Show one cloud render job with events
cutcli cloud result <jobId>	Alias for cloud job, useful when looking up final output

Scheduled rendering

Command	Purpose
cutcli timer render [--interval <minutes>] [--count <n>]	Create/upload/render drafts on a fixed interval
cutcli timer render --count 1 --pretty	Run a single upload/render cycle for smoke testing

Adding content

Command	Purpose	Detail
cutcli captions add	Add captions	More
cutcli images add	Add images	More
cutcli videos add	Add videos	More
cutcli audios add	Add audios	More
cutcli effects add	Add effects	More
cutcli filters add	Add filters	More
cutcli sticker add	Add a sticker	More
cutcli keyframes add	Add keyframes	More
cutcli masks add	Add masks	More

Querying

Command	Purpose
cutcli query audio-duration --url <url>	Get a remote audio's duration
cutcli query image-animations [--type in|out|loop]	Available image animations
cutcli query text-animations [--type in|out|loop]	Available text animations
cutcli query stickers --action search|categories|list	Stickers
cutcli query effects --action search|categories|list	Effects
cutcli query filters --action search|categories|list	Filters
cutcli query transitions --action search|categories|list	Transitions
cutcli query huazi --action list|search|categories	Decorative text styles ("huazi")

Config and integrations

Command	Purpose
cutcli config show [--pretty]	Show current config
cutcli config set-dir <path>	Set the draft output directory
cutcli setup <tool> [--force]	Install AI tool integration (cursor / claude / openclaw / all)
cutcli docs [topic]	Show built-in offline docs
cutcli docs open	Open https://docs.cutcli.com in your browser

A typical workflow

DRAFT_ID=$(cutcli draft create --width 1080 --height 1920 | jq -r '.draftId')

# Add a background image
cutcli images add "$DRAFT_ID" --image-infos '[
  {"imageUrl":"https://cutcli.com/assets/demo/scene-01.jpg",
   "width":1080,"height":1920,"start":0,"end":5000000}
]'

# Add a caption
cutcli captions add "$DRAFT_ID" --captions '[
  {"text":"Hello","start":0,"end":3000000,
   "inAnimation":"渐显","inAnimationDuration":500000}
]' --font-size 8 --bold

# Add background music
cutcli audios add "$DRAFT_ID" --audio-infos '[
  {"audioUrl":"https://cutcli.com/assets/demo/bgm-light.mp3",
   "duration":5000000,"start":0,"end":5000000,"volume":0.5}
]'

# Inspect
cutcli draft info "$DRAFT_ID" --pretty

Cloud render workflow

# Save credentials once, or export CUTCLI_API_KEY for the current shell
cutcli auth set --api-key cut_live_xxx_yyy

# Zip, upload, and submit a local draft to the cloud render queue
cutcli cloud render "$DRAFT_ID" --pretty

# Track queue status and retrieve the final video URL
cutcli cloud jobs --status queued --pretty
cutcli cloud job <renderJobId> --pretty

# Optional: run the built-in scheduler once, useful for CI/smoke checks
cutcli timer render --count 1 --pretty

Where the full reference lives

For exhaustive parameter tables and edge cases:

• Run cutcli <command> --help — always up to date for your installed version
• Or run cutcli docs <topic> — colorized offline manual
• The Chinese full reference at /zh/reference/cli (auto-synced from the source repo)
• Subcommand pages on this site have JSON field tables: see the side navigation