Youka CLI - Youka Docs

Youka CLI bao bọc public API để bạn có thể tạo karaoke từ một bài hát, tùy chỉnh lời và phong cách video, và xuất ra MP4 hoàn chỉnh từ terminal hoặc từ một agent.

Cài đặt

npm install -g @youka/cli

pnpm add -g @youka/cli

yarn global add @youka/cli

Xác minh cài đặt:

youka --version
youka --help

Thiết lập xác thực

Lấy API key

Truy cập online.youka.io/account, mở API keys, rồi sao chép một key mới.

Lưu key

Lưu bền vững key vào ~/.youka/config.json:

youka login YOUR_API_KEY

Hoặc export nó dưới dạng biến môi trường:

export YOUKA_API_KEY=YOUR_API_KEY

Tạo karaoke từ một tệp

Dùng tệp audio hoặc video cục bộ làm nguồn:

youka project create ./song.mp3 --download --output ./karaoke.mp4 --wait --json

Lệnh này sẽ tải lên nguồn, tạo dự án karaoke, render một bản xuất, và tải video MP4 hoàn chỉnh về.

Tạo karaoke từ một URL

Truyền một URL nguồn HTTP hoặc HTTPS thay vì đường dẫn tệp:

youka project create "https://example.com/song.mp4" --download --output ./karaoke.mp4 --wait --json

Với các URL video được host, Youka dùng yt-dlp để tải xuống từ URL. Bạn có thể cài các phụ thuộc tải URL trước lần import URL đầu tiên:

youka deps ensure --for url

Tham khảo

Account

Đăng nhập, đăng xuất và kiểm tra trạng thái xác thực.

Credits

Kiểm tra số dư hiện tại và các gói credit sắp hết hạn.

Billing

Hiển thị giá và tạo URL thanh toán hoặc URL cổng quản lý.

Projects

Tạo, kiểm tra, chờ và cập nhật các dự án.

Exports

Render các artifact export trên cloud hoặc local và tải chúng xuống.

Presets

Quản lý các cấu hình render có thể tái sử dụng.

Media

Tải lên và quản lý media có thể tái sử dụng.

Tasks

Kiểm tra trạng thái tác vụ mức thấp khi cần.

Dependencies

Kiểm tra và cài đặt các phụ thuộc cho import URL và render local.

Global options

Các cờ có sẵn trên mọi lệnh.

Sẵn sàng cho agent theo mặc định

Mọi lệnh đều hỗ trợ chế độ máy có thể đọc được, trả về một JSON envelope duy nhất với cấu trúc ổn định. Dùng các cờ này để điều khiển CLI từ agent hoặc script:

Flag	Mục đích
`--json`	In đúng một JSON envelope ra stdout. Tiến trình và log sẽ bị ẩn.
`--body <file\|->`	Hợp nhất payload JSON từ một tệp hoặc stdin. Cờ CLI sẽ ghi đè các trường trùng.
`--wait`	Poll các job async (project create, exports) cho đến khi đạt trạng thái kết thúc.
`--idempotency-key <key>`	Truyền idempotency key cho mọi thao tác ghi.
`--quiet`	Ẩn output tiến trình không phải JSON khi dùng với `--wait`.
`--api <url>`	Ghi đè base URL của public API.

Cấu trúc JSON envelope:

{
  "ok": true,
  "data": {
    /* command result */
  }
}

Khi thất bại:

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Human-readable description",
    "details": {
      /* optional */
    }
  }
}

Xem Global options để biết danh sách đầy đủ.

Xuất trên cloud vs local

export create mặc định chạy trên cloud. Truyền --local để render trên máy của bạn bằng toolchain Remotion đi kèm. Render local cần các phụ thuộc render:

youka deps ensure --for render

Xem Exports để biết quy trình đầy đủ.

Tiếp theo là gì

Account - lưu API key của bạn
Projects - tạo và xử lý dự án
Exports - render video karaoke hoàn chỉnh
AI agents - điều khiển CLI từ một quy trình tự động hóa

​Cài đặt

​Thiết lập xác thực

​Tạo karaoke từ một tệp

​Tạo karaoke từ một URL

​Tham khảo