werk1112

Video CLI commands and options

Build scope: canonical Linux, --no-default-features, no optional backend features. Coverage is limited to this parser/schema profile, not every platform or feature build. See conditional build options for extensions.

Generated from werk 1.10.2. See CLI semantics, media input and override rules, and the canonical parameter schema.

Every command below also accepts global options and --help. Each command lists its additional accepted options; the catalogue below gives their syntax and meaning. A parsed flag does not imply that a particular model/backend implements it.

Commands

werk video

Generate, animate, transform, or upscale video

werk video [OPTIONS] <COMMAND>

Subcommands: werk video generate, werk video animate, werk video transform, werk video upscale.

werk video generate

Generate a video with an installed model

werk video generate [OPTIONS] <MODEL>

Arguments:

<MODEL>

Additional options:

werk video animate

Animate an image with an installed model

werk video animate [OPTIONS] --image <PATH> <MODEL>

Arguments:

<MODEL>

Additional options:

werk video transform

Transform an existing video with an installed model

werk video transform [OPTIONS] --video <PATH> <MODEL>

Arguments:

<MODEL>

Additional options:

werk video upscale

Upscale an existing video with an installed model

werk video upscale [OPTIONS] --video <PATH> <MODEL>

Arguments:

<MODEL>

Additional options:

Option catalogue

Syntax ending in ... accepts repeated values. List controls also accept repeated occurrences of their flag. Boolean pairs inherit when omitted; positive and negative flags conflict. Schema defaults, units, types and task applicability are in the linked parameter table.

--accelerator

--accelerator <ACCELERATOR>

Requested accelerator, for example cpu, cuda, rocm, metal, or auto

--allow-component-offload

--allow-component-offload

Permit component offload when GPU memory is insufficient and projected host RAM fits

--allow-cpu-offload

--allow-cpu-offload

Permit model CPU offload when GPU memory is insufficient and the projected host-RAM requirement fits

--allow-disk-offload

--allow-disk-offload

Allow disk-backed model offloading; boolean routing.allow_disk_offload.

--allow-sequential-offload

--allow-sequential-offload

Permit slower sequential CPU offload when GPU memory is insufficient and projected host RAM fits

--aspect-ratio

--aspect-ratio <ASPECT_RATIO>

Aspect ratio (runtime/model-defined control); string video.aspect_ratio.

--attention-backend

--attention-backend <ATTENTION_BACKEND>

Requested attention implementation

--batch-size

--batch-size <BATCH_SIZE>

Videos processed per batch; integer video.batch_size.

--bitrate

--bitrate <BITRATE>

Bitrate (runtime/model-defined control); string video.bitrate.

--camera-motion

--camera-motion <CAMERA_MOTION>

Camera motion (runtime/model-defined control); string video.camera_motion.

--camera-strength

--camera-strength <CAMERA_STRENGTH>

Camera strength (runtime/model-defined control); number video.camera_strength.

--codec

--codec <CODEC>

Codec (runtime/model-defined control); string video.codec.

--compile

--compile

Explicitly enable runtime compilation

--context-frames

--context-frames <CONTEXT_FRAMES>

Context frames (runtime/model-defined control); integer video.context_frames.

--context-overlap

--context-overlap <CONTEXT_OVERLAP>

Context overlap (runtime/model-defined control); integer video.context_overlap.

--context-stride

--context-stride <CONTEXT_STRIDE>

Context stride (runtime/model-defined control); integer video.context_stride.

--control-video

--control-video <PATH>

Control video (runtime/model-defined control); path video.control_video.

--crf

--crf <CRF>

Crf (runtime/model-defined control); integer video.crf.

--debug

--debug

Print the resolved media request, routing candidates, and backend details

--decode-chunk-size

--decode-chunk-size <DECODE_CHUNK_SIZE>

Decode chunk size (runtime/model-defined control); integer video.decode_chunk_size.

--denoise-strength

--denoise-strength <DENOISE_STRENGTH>

Denoise strength (runtime/model-defined control); number video.denoise_strength.

--depth-video

--depth-video <PATH>

Depth video (runtime/model-defined control); path video.depth_video.

--duration

--duration <SECONDS>

Duration (runtime/model-defined control); number video.duration.

--encoding-preset

--encoding-preset <ENCODING_PRESET>

Encoding preset (runtime/model-defined control); string video.encoding_preset.

--eta

--eta <ETA>

Eta (runtime/model-defined control); number video.eta.

--exclude-audio

--exclude-audio

Explicitly disable: Include audio (runtime/model-defined control); boolean video.include_audio.

--extension-direction

--extension-direction <EXTENSION_DIRECTION>

Extension direction (runtime/model-defined control); enumeration video.extension_direction.

--extension-frames

--extension-frames <EXTENSION_FRAMES>

Extension frames (runtime/model-defined control); integer video.extension_frames.

--fallback-policy

--fallback-policy <FALLBACK_POLICY>

Fallback policy: none, backend, or degrade; degrade permits inherited memory-saving strategies

--final-image

--final-image <PATH>

Final image (runtime/model-defined control); path video.final_image.

--first-frame-strength

--first-frame-strength <FIRST_FRAME_STRENGTH>

First frame strength (runtime/model-defined control); number video.first_frame_strength.

--flow-shift

--flow-shift <FLOW_SHIFT>

Flow shift (runtime/model-defined control); number video.flow_shift.

--fps

--fps <FPS>

Frames per second; number video.fps.

--frame-interpolation

--frame-interpolation

Frame interpolation (runtime/model-defined control); boolean video.frame_interpolation.

--frames

--frames <FRAMES>

Number of generated frames; integer video.frames.

--guidance

--guidance <GUIDANCE>

Guidance scale; number video.guidance.

--height

--height <HEIGHT>

Output height in pixels; integer video.height.

--image

--image <PATH>

Source image; required where shown in the command usage. Path, HTTP(S) URL or Base64 data URL.

--image-strength

--image-strength <IMAGE_STRENGTH>

Image strength (runtime/model-defined control); number video.image_strength.

--include-audio

--include-audio

Include audio (runtime/model-defined control); boolean video.include_audio.

--initial-image

--initial-image <PATH>

Initial image for image-to-video generation. Path, HTTP(S) URL or Base64 data URL.

--interpolation-factor

--interpolation-factor <INTERPOLATION_FACTOR>

Interpolation factor (runtime/model-defined control); number video.interpolation_factor.

--last-frame-strength

--last-frame-strength <LAST_FRAME_STRENGTH>

Last frame strength (runtime/model-defined control); number video.last_frame_strength.

--loop

--loop

Looping (runtime/model-defined control); boolean video.looping.

--loop-blend-frames

--loop-blend-frames <LOOP_BLEND_FRAMES>

Loop blend frames (runtime/model-defined control); integer video.loop_blend_frames.

--mask-video

--mask-video <PATH>

Mask video (runtime/model-defined control); path video.mask_video.

--motion-bucket

--motion-bucket <MOTION_BUCKET>

Motion bucket (runtime/model-defined control); integer video.motion_bucket.

--motion-strength

--motion-strength <MOTION_STRENGTH>

Motion strength (runtime/model-defined control); number video.motion_strength.

--negative-prompt

--negative-prompt <NEGATIVE_PROMPT>

Negative prompt text

--negative-prompt-file

--negative-prompt-file <PATH>

Read negative prompt text from a file

--no-allow-component-offload

--no-allow-component-offload

Forbid component offload

--no-allow-cpu-offload

--no-allow-cpu-offload

Forbid model CPU offload; an over-limit GPU plan fails unless another strategy is explicitly permitted

--no-allow-disk-offload

--no-allow-disk-offload

Explicitly disable: Allow disk-backed model offloading; boolean routing.allow_disk_offload.

--no-allow-sequential-offload

--no-allow-sequential-offload

Forbid sequential CPU offload

--no-compile

--no-compile

Explicitly disable runtime compilation

--no-frame-interpolation

--no-frame-interpolation

Explicitly disable: Frame interpolation (runtime/model-defined control); boolean video.frame_interpolation.

--no-loop

--no-loop

Explicitly disable: Looping (runtime/model-defined control); boolean video.looping.

--no-stabilization

--no-stabilization

Explicitly disable: Stabilization (runtime/model-defined control); boolean video.stabilization.

--no-temporal-vae-tiling

--no-temporal-vae-tiling

Explicitly disable: Tile temporal VAE operations; boolean video.temporal_vae_tiling.

--no-upscaling

--no-upscaling

Explicitly disable: Upscaling (runtime/model-defined control); boolean video.upscaling.

--noise-augmentation

--noise-augmentation <NOISE_AUGMENTATION>

Noise augmentation (runtime/model-defined control); number video.noise_augmentation.

--num-videos

--num-videos <NUM_VIDEOS>

Number of videos to create; integer video.num_videos.

--output

--output <PATH>

Output file or directory; defaults to WERK_HOME/outputs with a generated name

--output-format

--output-format <OUTPUT_FORMAT>

Video container; enumeration video.output_format.

--parameter-policy

--parameter-policy <PARAMETER_POLICY>

Parameter support policy: strict, warn, or permissive

--performance-preference

--performance-preference <PERFORMANCE_PREFERENCE>

Performance preference, for example speed, balanced, memory, or quality

--pixel-format

--pixel-format <PIXEL_FORMAT>

Pixel format (runtime/model-defined control); string video.pixel_format.

--pose-video

--pose-video <PATH>

Pose video (runtime/model-defined control); path video.pose_video.

--precision

--precision <PRECISION>

Requested compute precision

--profile

--profile <PROFILE>

Stored or built-in execution profile

--prompt

--prompt <PROMPT>

Prompt text

--prompt-file

--prompt-file <PATH>

Read prompt text from a file

--quality

--quality <QUALITY>

Quality profile

--quantization

--quantization <QUANTIZATION>

Requested quantization

--reference-audio

--reference-audio <PATH_OR_URL>

Reference audio (runtime/model-defined control); path video.reference_audio.

--reference-image

--reference-image <PATH_OR_URL>

Repeatable item for: Reference images (runtime/model-defined control); list video.reference_images.

--reference-image-file

--reference-image-file <PATH>

Load JSON from a UTF-8 file for: Reference images (runtime/model-defined control); list video.reference_images.

--reference-image-json

--reference-image-json <JSON>

Load JSON from the argument for: Reference images (runtime/model-defined control); list video.reference_images.

--rho

--rho <RHO>

Rho (runtime/model-defined control); number video.rho.

--sampler

--sampler <SAMPLER>

Sampler (runtime/model-defined control); string video.sampler.

--scheduler

--scheduler <SCHEDULER>

Scheduler (runtime/model-defined control); string video.scheduler.

--seed

--seed <SEED>

Random seed; integer video.seed.

--set

--set <PATH=VALUE>

Set an advanced raw override; may be repeated

--shift

--shift <SHIFT>

Shift (runtime/model-defined control); number video.shift.

--sigma

--sigma <SIGMAS>

Repeatable item for: Sigmas (runtime/model-defined control); list video.sigmas.

--sigma-max

--sigma-max <SIGMA_MAX>

Sigma max (runtime/model-defined control); number video.sigma_max.

--sigma-min

--sigma-min <SIGMA_MIN>

Sigma min (runtime/model-defined control); number video.sigma_min.

--stabilization

--stabilization

Stabilization (runtime/model-defined control); boolean video.stabilization.

--steps

--steps <STEPS>

Denoising steps; integer video.steps.

--temporal-consistency

--temporal-consistency <TEMPORAL_CONSISTENCY>

Temporal consistency (runtime/model-defined control); number video.temporal_consistency.

--temporal-guidance

--temporal-guidance <TEMPORAL_GUIDANCE>

Temporal guidance (runtime/model-defined control); number video.temporal_guidance.

--temporal-vae-tiling

--temporal-vae-tiling

Tile temporal VAE operations; boolean video.temporal_vae_tiling.

--tile-frames

--tile-frames <TILE_FRAMES>

Tile frames (runtime/model-defined control); integer video.tile_frames.

--tile-height

--tile-height <TILE_HEIGHT>

Tile height (runtime/model-defined control); integer video.tile_height.

--tile-overlap

--tile-overlap <TILE_OVERLAP>

Tile overlap (runtime/model-defined control); integer video.tile_overlap.

--tile-width

--tile-width <TILE_WIDTH>

Tile width (runtime/model-defined control); integer video.tile_width.

--timeout

--timeout <SECONDS>

Execution timeout in seconds

--upscale-scale

--upscale-scale <UPSCALE_SCALE>

Upscale scale (runtime/model-defined control); number video.upscale_scale.

--upscaling

--upscaling

Upscaling (runtime/model-defined control); boolean video.upscaling.

--verbose

--verbose

Print media-specific timing, runtime, and output statistics

--video

--video <PATH>

Source video; required where shown in the command usage. Path, HTTP(S) URL or Base64 data URL.

--video-adapter

--video-adapter <SPEC>

Repeatable item for: Adapters (runtime/model-defined control); list video.adapters.

--video-adapter-file

--video-adapter-file <PATH>

Load JSON from a UTF-8 file for: Adapters (runtime/model-defined control); list video.adapters.

--video-adapter-json

--video-adapter-json <JSON>

Load JSON from the argument for: Adapters (runtime/model-defined control); list video.adapters.

--video-adapter-schedule

--video-adapter-schedule <SPEC>

Repeatable item for: Adapter schedule (runtime/model-defined control); list video.adapter_schedule.

--video-adapter-schedule-file

--video-adapter-schedule-file <PATH>

Load JSON from a UTF-8 file for: Adapter schedule (runtime/model-defined control); list video.adapter_schedule.

--video-adapter-schedule-json

--video-adapter-schedule-json <JSON>

Load JSON from the argument for: Adapter schedule (runtime/model-defined control); list video.adapter_schedule.

--video-camera-keyframe

--video-camera-keyframe <SPEC>

Repeatable item for: Camera keyframes (runtime/model-defined control); list video.camera_keyframes.

--video-camera-keyframe-file

--video-camera-keyframe-file <PATH>

Load JSON from a UTF-8 file for: Camera keyframes (runtime/model-defined control); list video.camera_keyframes.

--video-camera-keyframe-json

--video-camera-keyframe-json <JSON>

Load JSON from the argument for: Camera keyframes (runtime/model-defined control); list video.camera_keyframes.

--video-control

--video-control <SPEC>

Repeatable item for: Controls (runtime/model-defined control); list video.controls.

--video-control-file

--video-control-file <PATH>

Load JSON from a UTF-8 file for: Controls (runtime/model-defined control); list video.controls.

--video-control-json

--video-control-json <JSON>

Load JSON from the argument for: Controls (runtime/model-defined control); list video.controls.

--video-denoise-schedule

--video-denoise-schedule <SPEC>

Repeatable item for: Denoise schedule (runtime/model-defined control); list video.denoise_schedule.

--video-denoise-schedule-file

--video-denoise-schedule-file <PATH>

Load JSON from a UTF-8 file for: Denoise schedule (runtime/model-defined control); list video.denoise_schedule.

--video-denoise-schedule-json

--video-denoise-schedule-json <JSON>

Load JSON from the argument for: Denoise schedule (runtime/model-defined control); list video.denoise_schedule.

--video-guidance-schedule

--video-guidance-schedule <SPEC>

Repeatable item for: Guidance schedule (runtime/model-defined control); list video.guidance_schedule.

--video-guidance-schedule-file

--video-guidance-schedule-file <PATH>

Load JSON from a UTF-8 file for: Guidance schedule (runtime/model-defined control); list video.guidance_schedule.

--video-guidance-schedule-json

--video-guidance-schedule-json <JSON>

Load JSON from the argument for: Guidance schedule (runtime/model-defined control); list video.guidance_schedule.

--video-prompt-keyframe

--video-prompt-keyframe <SPEC>

Repeatable item for: Prompt keyframes (runtime/model-defined control); list video.prompt_keyframes.

--video-prompt-keyframe-file

--video-prompt-keyframe-file <PATH>

Load JSON from a UTF-8 file for: Prompt keyframes (runtime/model-defined control); list video.prompt_keyframes.

--video-prompt-keyframe-json

--video-prompt-keyframe-json <JSON>

Load JSON from the argument for: Prompt keyframes (runtime/model-defined control); list video.prompt_keyframes.

--video-strength

--video-strength <VIDEO_STRENGTH>

Video strength (runtime/model-defined control); number video.video_strength.

--width

--width <WIDTH>

Output width in pixels; integer video.width.

--window-overlap

--window-overlap <WINDOW_OVERLAP>

Window overlap (runtime/model-defined control); integer video.window_overlap.

--window-size

--window-size <WINDOW_SIZE>

Window size (runtime/model-defined control); integer video.window_size.

This site is open source. Improve this page.