Exports

An export is a rendered artifact produced from a project. Exports run in the cloud by default. Pass --local to render on your own machine with the local Remotion pipeline.

`export create`

Render a new export for a project.

youka export create <projectId> [options]

string

required

The project to export.

Options

Option	Description
`--version-id <versionId>`	Choose a project version. Defaults to the primary version.
`--fps <fps>`	Frames per second. `25`, `30`, or `60`.
`--mute-all`	Set all project stem volumes to zero.
`--resolution <value>`	`480p`, `720p`, `1080p`, or `4k`
`--quality <value>`	`low`, `medium`, or `high`
`--speed <number>`	Playback speed multiplier
`--tone <number>`	Pitch shift multiplier
`--transparent`	Render with a transparent background
`--preset <presetId>`	Preset override for this export
`--volume <stem=value>`	Set stem volume by type. Repeatable
`--local`	Render locally instead of in the cloud
`--download`	Wait for the export and download it
`--output <path>`	Output file or directory for local render or download

Stem volumes

Use --volume <type>=<value>. Valid types are original, vocals, instrumental, and backing_vocals. Values must be between 0 and 1.

Cloud render

youka export create $PROJECT_ID \
  --resolution 1080p \
  --quality high \
  --wait \
  --download \
  --output ./karaoke.mp4 \
  --json

Local render

Local rendering runs the Remotion pipeline on your machine. First ensure the render dependencies are installed:

youka deps ensure --for render

Then export with --local:

youka export create $PROJECT_ID \
  --local \
  --resolution 1080p \
  --output ./karaoke.mp4 \
  --json

Local renders write directly to the --output path. Do not pass --download with --local; the CLI rejects that combination because there is no cloud artifact to download after a local render.

`export quote`

Quote the credits required for a cloud export without starting the export.

youka export quote <projectId> [options]

export quote only quotes cloud exports. Local exports run on your machine and do not use cloud export credits.

Option	Description
`--version-id <versionId>`	Choose a project version. Defaults to the primary version.
`--fps <fps>`	Frames per second. `25`, `30`, or `60`.
`--mute-all`	Set all project stem volumes to zero.
`--resolution <value>`	`480p`, `720p`, `1080p`, or `4k`
`--quality <value>`	`low`, `medium`, or `high`
`--speed <number>`	Playback speed multiplier
`--tone <number>`	Pitch shift multiplier
`--transparent`	Render with a transparent background
`--preset <presetId>`	Preset override for this export
`--volume <stem=value>`	Set stem volume by type. Repeatable

Example:

youka export quote $PROJECT_ID \
  --resolution 1080p \
  --quality high \
  --json

`export list`

List exports for a project.

youka export list <projectId> [--page <n>] [--page-size <n>]

Option	Default	Description
`--page`	`1`	Page number.
`--page-size`	`100`	Page size. Maximum `100`.

Example:

youka export list $PROJECT_ID --page-size 50 --json

`export show`

Fetch one export by ID.

youka export show <exportId>
youka export show <exportId> --json

`export wait`

Poll an export until it reaches a terminal state.

youka export wait <exportId> --json

`export download`

Download an existing export by ID.

youka export download <exportId> [--output <file>]

Example:

youka export download $EXPORT_ID \
  --output ./karaoke.mp4

What’s next

Projects - create or wait on projects before exporting
Presets - reuse render settings across exports
Dependencies - inspect and install local render dependencies

Export a transparent lyric overlay

youka export create proj_example --version-id ver_example --local --transparent --mute-all --fps 30 --output ./overlay.mov --json

Transparent local output uses ProRes 4444 in a MOV container. --mute-all silences all project stems. Silence does not promise that the output has no audio stream. Inspect the file if your editing software requires an absent audio stream. Existing feature eligibility still applies. See Automate lyric videos for timing edits and render snapshot metadata.

Overview

Reference

`export create`

Options

Stem volumes

Cloud render

Local render

`export quote`

`export list`

`export show`

`export wait`

`export download`

What’s next

Export a transparent lyric overlay

​export create

​Options

​Stem volumes

​Cloud render

​Local render

​export quote

​export list

​export show

​export wait

​export download

​What’s next

​Export a transparent lyric overlay

`export create`

Options

Stem volumes

Cloud render

Local render

`export quote`

`export list`

`export show`

`export wait`

`export download`

What’s next

Export a transparent lyric overlay