Skip to main content
كل أمر youka يقبل نفس مجموعة الأعلام العامة. تتحكم هذه الأعلام في وضع الإخراج، ومعالجة الإدخال، وسلوك الانتظار، وواجهة API المستهدفة.

الأعلام

العلمالوصف
--jsonوضع الآلة: يطبع ظرف JSON واحدًا فقط إلى stdout. يتم كتم السجلات ومؤشرات التقدم.
--body <file|->يدمج كائن JSON من ملف أو من stdin. تتفوّق أعلام CLI على الحقول المطابقة القادمة من --body.
--waitيستقصي المورد الذي تم إنشاؤه حتى يصل إلى حالة نهائية. شائع في project create وproject sync وproject separate وexport create.
--idempotency-key <key>يمرّر مفتاح عدم التكرار إلى الـ API في عمليات الكتابة.
--quietيكتم مخرجات التقدم غير الخاصة بـ JSON عند استخدامه مع --wait.
--no-colorيعطّل إخراج ألوان ANSI.
--api <url>يتجاوز عنوان URL الأساسي للـ API. تتم إضافة اللاحقة /ar/api/v1 تلقائيًا عند الحاجة.

ظرف JSON

مع --json، يكتب CLI ظرفًا واحدًا فقط إلى stdout ولا شيء غير ذلك. نجاح:
{
  "ok": true,
  "data": {
    /* command result */
  }
}
فشل:
{
  "ok": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key.",
    "details": null
  }
}
رموز الخروج:
الرمزالمعنى
0نجاح.
1خطأ وقت التشغيل (الشبكة، API، العرض).
2إدخال غير صالح (أعلام خاطئة، حمولة غير مقروءة).
مرّر الظرف عبر jq لاستخدامه في السكربتات: youka project show $ID --json | jq '.data.state'.

تمرير أجسام JSON

أي أمر إنشاء أو تحديث يقبل --body لتمرير جسم الطلب كاملًا. استخدمه بدلًا من تهريب JSON كبير على سطر الأوامر.
youka preset create --body ./preset.json --json

الانتظار للمهام غير المتزامنة

يقوم --wait باستقصاء المورد الذي تم إنشاؤه نيابةً عنك ويعيد الحالة النهائية. بدون --wait، تعود الأوامر بمجرد وضع المهمة في قائمة الانتظار.
youka project create ./song.mp3 --wait --json
youka export create $ID --wait --download --output ./out.mp4
اقرن --wait مع --quiet في السكربتات لكتم شريط التقدم مع الاستمرار في طباعة نتيجة JSON.

عدم التكرار

مرّر --idempotency-key لجعل أوامر الكتابة آمنة لإعادة المحاولة. إن إعادة استخدام نفس المفتاح مع نفس الحمولة يعيد النتيجة الأصلية بدلًا من إنشاء نسخة مكررة.
youka project create ./song.mp3 \
  --idempotency-key "import-2026-04-08-song-001" \
  --json
استخدم مفاتيح عدم التكرار كلما كان من الممكن أن يعيد وكيل المحاولة بعد انتهاء المهلة.

متغيرات البيئة

المتغيرالغرض
YOUKA_API_KEYمفتاح API المستخدم عندما لا يتم تعيينه عبر youka login.
YOUKA_API_BASE_URLعنوان URL أساسي بديل للـ API. يتم تجاوزه بواسطة --api.

ما التالي