Youka CLI - Youka Docs

Youka CLI सार्वजनिक API को रैप करता है ताकि आप किसी गाने से कराओके बना सकें, लिरिक्स और वीडियो स्टाइल को कस्टमाइज़ कर सकें, और अपने टर्मिनल या किसी एजेंट से तैयार MP4 एक्सपोर्ट कर सकें।

Install

npm install -g @youka/cli

pnpm add -g @youka/cli

yarn global add @youka/cli

इंस्टॉल की पुष्टि करें:

youka --version
youka --help

Set up auth

Get an API key

online.youka.io/account पर जाएँ, API keys खोलें, और एक नई key कॉपी करें।

Save the key

key को ~/.youka/config.json में सेव रखें:

youka login YOUR_API_KEY

या इसे environment variable के रूप में export करें:

export YOUKA_API_KEY=YOUR_API_KEY

Create karaoke from a file

सोर्स के रूप में लोकल ऑडियो या वीडियो फ़ाइल का उपयोग करें:

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

यह सोर्स को अपलोड करता है, कराओके प्रोजेक्ट बनाता है, एक एक्सपोर्ट रेंडर करता है, और तैयार MP4 वीडियो डाउनलोड करता है।

Create karaoke from a URL

फ़ाइल पाथ की जगह HTTP या HTTPS सोर्स URL पास करें:

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

होस्टेड वीडियो URLs के लिए, Youka URL से डाउनलोड करने हेतु yt-dlp का उपयोग करता है। पहली URL import से पहले आप URL डाउनलोड dependencies इंस्टॉल कर सकते हैं:

youka deps ensure --for url

Reference

Account

लॉग इन, लॉग आउट करें, और auth स्टेट की जाँच करें।

Credits

वर्तमान बैलेंस और एक्सपायर होने वाले क्रेडिट पैकेज देखें।

Billing

प्राइसिंग दिखाएँ और checkout या portal URLs बनाएँ।

Projects

प्रोजेक्ट बनाएँ, देखें, उन पर wait करें, और अपडेट करें।

Exports

क्लाउड या लोकल एक्सपोर्ट आर्टिफैक्ट्स रेंडर करें और उन्हें डाउनलोड करें।

Presets

पुन: उपयोग योग्य रेंडर कॉन्फ़िगरेशन मैनेज करें।

Media

पुन: उपयोग योग्य मीडिया अपलोड करें और मैनेज करें।

Tasks

ज़रूरत पड़ने पर लो-लेवल टास्क स्टेट की जाँच करें।

Dependencies

URL import और लोकल रेंडर dependencies की जाँच करें और इंस्टॉल करें।

Global options

हर कमांड पर उपलब्ध flags।

Agent-ready by default

हर कमांड एक machine-readable मोड सपोर्ट करता है, जो स्थिर shape वाला एक ही JSON envelope लौटाता है। एजेंट्स या स्क्रिप्ट्स से CLI चलाने के लिए इन flags का उपयोग करें:

Flag	Purpose
`--json`	stdout पर ठीक एक JSON envelope प्रिंट करें। प्रोग्रेस और लॉग्स दबा दिए जाते हैं।
`--body <file\|->`	किसी फ़ाइल या stdin से JSON payload मर्ज करें। CLI flags मैच होने वाले फ़ील्ड्स को ओवरराइड करते हैं।
`--wait`	async jobs (project create, exports) को तब तक poll करें जब तक वे terminal state में न पहुँच जाएँ।
`--idempotency-key <key>`	किसी भी write operation को idempotency key पास करें।
`--quiet`	`--wait` के साथ उपयोग करने पर non-JSON प्रोग्रेस आउटपुट दबाएँ।
`--api <url>`	public API base URL को ओवरराइड करें।

JSON envelope shape:

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

फेल होने पर:

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

पूरी सूची के लिए Global options देखें।

Cloud vs local export

export create डिफ़ॉल्ट रूप से क्लाउड में चलता है। बंडल्ड Remotion toolchain का उपयोग करके अपनी मशीन पर रेंडर करने के लिए --local पास करें। लोकल रेंडर्स के लिए render dependencies चाहिए:

youka deps ensure --for render

पूरे वर्कफ़्लो के लिए Exports देखें।

What’s next

Account - अपनी API key सेव करें
Projects - प्रोजेक्ट बनाएँ और प्रोसेस करें
Exports - तैयार कराओके वीडियो रेंडर करें
AI agents - ऑटोमेटेड वर्कफ़्लो से CLI चलाएँ

​Install

​Set up auth

​Create karaoke from a file

​Create karaoke from a URL

​Reference