ملف التكوين
2 دقيقة للقراءة
كل مشروع OpenCX يحتوي على ملف opencx.json في جذر المشروع. يتم إنشاؤه تلقائيًا بواسطة opencx auth login أو opencx content init.
أضف مفتاح $schema يشير إلى مخطط JSON الخاص بـ CLI لإكمال وتحقق المحرر:
json
{
"$schema": "./node_modules/@opencx/cli/schemas/opencx-config.schema.json",
...
}
الحقول
| الحقل | النوع | مطلوب | الافتراضي | الوصف |
|---|---|---|---|---|
help_center_id | string | نعم | -- | معرف مركز المساعدة الذي يتزامن معه هذا المشروع. |
content_dir | string | لا | "docs" | المسار النسبي للدليل الذي يحتوي على ملفات المحتوى الخاصة بك. |
api_url | URL string | لا | "https://api.open.cx" | عنوان URL الأساسي لواجهة برمجة تطبيقات OpenCX. تجاوز للاستخدامات المستضافة ذاتيًا. |
dashboard_url | URL string | لا | -- | عنوان URL للوحة معلومات OpenCX. يستخدم لإنشاء الروابط. |
provider | string | لا | -- | معرف مزود المحتوى. |
categories | object | لا | -- | بيانات الفئة مفاتيحها حسب المسار (مثل "getting-started", "billing"). كل قيمة: { "name": string, "description"?: string, "icon"?: string }. عند فقدانها لمسار، يتم اشتقاق اسم الفئة من اسم الدليل. |
مثال
json
{
"$schema": "./node_modules/@opencx/cli/schemas/opencx-config.schema.json",
"help_center_id": "hc_abc123",
"content_dir": "docs",
"api_url": "https://api.open.cx",
"dashboard_url": "https://app.open.cx",
"categories": {
"getting-started": { "name": "البدء" },
"billing": {
"name": "الفواتير والمدفوعات",
"description": "الفواتير والاشتراكات",
"icon": "credit-card"
}
}
}
كيفية إنشائه
تشغيل opencx auth login أو opencx content init يكتب هذا الملف إلى دليل العمل الحالي الخاص بك. يتم اختيار help_center_id بشكل تفاعلي أثناء الإعداد، ويتم ملء الحقول الباقية بالقيم الافتراضية المناسبة.
التحقق
يقوم CLI بالتحقق من opencx.json في كل أمر يقرأه. إذا كانت الحقول المطلوبة مفقودة أو القيم مشوهة، سترى رسالة خطأ واضحة تشير إلى الحقل غير الصحيح. يجب أن تكون الحقول api_url و dashboard_url عناوين URL صالحة.