Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.youka.io/llms.txt

Use this file to discover all available pages before exploring further.

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]
​
projectId
string
required
The project to export.

​
Options

OptionDescription
--resolution <value>480p, 720p, or 1080p
--quality <value>low, medium, or high
--speed <number>Playback speed multiplier
--tone <number>Pitch shift multiplier
--transparentRender with a transparent background
--preset <presetId>Preset override for this export
--volume <stem=value>Set stem volume by type. Repeatable
--localRender locally instead of in the cloud
--downloadWait 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.
OptionDescription
--resolution <value>480p, 720p, or 1080p
--quality <value>low, medium, or high
--speed <number>Playback speed multiplier
--tone <number>Pitch shift multiplier
--transparentRender 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>]
OptionDefaultDescription
--page1Page number.
--page-size100Page 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