CLI مرجع الأوامر
تشغيل champrep --help و champrep COMMAND --help للحصول على المعلمات الدقيقة المضمنة في الإصدار المثبت. تلخص هذه الصفحة شجرة الأوامر العامة الحالية.
العلامات العامة
Section titled “العلامات العامة”| العلامة | الغرض |
|---|---|
--env NAME |
تجاوز بيئة البوابة النشطة لأمر واحد. |
-v, --verbose |
تسجيل بيانات تعريف الطلب والاستجابة مع حجب رأس التفويض. |
--debug |
إضافة نصوص الطلب والاستجابة إلى مخرجات التشخيص. استخدم بحذر عند التعامل مع البيانات الحساسة. |
--json |
إصدار JSON قابل للقراءة آليًّا حيثما كان ذلك مدعومًا. |
--no-color |
تعطيل ألوان ANSI. كما يلتزم البرنامج أيضًاCLI بـ NO_COLOR. |
وضع العلامات الدائمة قبل أو بعد أمر فرعي وفقًا لما يقبله الإصدار المثبت. تفضيل --json لأغراض الأتمتة.
المصادقة
Section titled “المصادقة”| الأمر | الغرض |
|---|---|
champrep auth login |
تسجيل الدخول من خلال الموافقة عبر المتصفح. |
champrep auth login --no-browser |
طباعة عنوان URL للموافقة الخاص بجهاز طرفي بعيد. |
champrep auth token |
تخزين APIمفتاح محدد النطاق في سلسلة مفاتيح نظام التشغيل. |
champrep auth whoami |
عرض الهوية والملف الشخصي النشطين. |
champrep auth status |
عرض الهوية، والحصة الحالية، وسياق التدقيق المتاح. |
champrep auth list |
عرض قائمة بالملفات الشخصية المخزنة عبر البيئات المختلفة. |
champrep auth switch PROFILE |
تحديد ملف تعريف مخزن آخر لنفس الحساب. |
champrep auth logout |
إزالة بيانات الاعتماد المحلية الحالية وحالة ملف التعريف. |
| الأمر | الغرض |
|---|---|
champrep drive ls [REMOTE_PATH] |
عرض قائمة بالملفات الموجودة في مجلد. |
champrep drive tree [REMOTE_PATH] |
عرض شجرة مجلدات متكررة. |
champrep drive cp SOURCE DEST |
نقل ملف بين الجهاز المحلي وDrive. |
champrep drive mv OLD NEW |
نقل عنصرDrive أو إعادة تسميته. |
champrep drive rm REMOTE_PATH |
حذف ملف أو مجلد. |
champrep drive mkdir REMOTE_PATH |
إنشاء مجلد. |
champrep drive quota |
عرض مساحة التخزين المستخدمة والمتاحة. |
أمثلة:
champrep drive ls /champrep drive tree /projectschamprep drive cp ./report.pdf /reports/report.pdfchamprep drive cp /reports/report.pdf ./report.pdfchamprep drive quota --json| الأمر | الغرض |
|---|---|
champrep mail ls |
عرض قائمة بالرسائل الموجودة في مجلد صندوق البريد. |
champrep mail read MESSAGE_ID |
طباعة رسالة واحدة. |
champrep mail send |
إرسال رسالة باستخدام العلامات أو المطالبات. |
champrep mail accounts |
عرض قائمة بصناديق البريد المتصلة. |
champrep mail threads |
عرض قائمة بسلسلة الرسائل. |
champrep mail domains |
عرض قائمة بمجالات البريد المرئية. |
استخدام champrep mail send --help قبل كتابة البرنامج النصي لعملية الإرسال حتى تتم معالجة علامات المستلم والموضوع والنص والمرفقات الخاصة بالإصدار المثبت بشكل صحيح.
| الأمر | الغرض |
|---|---|
champrep chat ls |
عرض قائمة بالغرف. |
champrep chat read ROOM_ID |
قراءة الرسائل الأخيرة. |
champrep chat send ROOM_ID |
إرسال رسالة إلى الغرفة. |
champrep chat unread |
عرض عدد الملاحظات غير المقروءة. |
champrep chat create |
إنشاء غرفة. |
Contacts
Section titled “Contacts”| الأمر | الغرض |
|---|---|
champrep contacts ls |
عرض قائمة جهات الاتصال. |
champrep contacts search QUERY |
البحث حسب البريد الإلكتروني أو الاسم. |
champrep contacts read CONTACT_ID |
عرض جهة اتصال واحدة. |
champrep contacts labels |
عرض قائمة بالتصنيفات. |
champrep contacts add USER_ID |
إضافة مستخدم إلى جهات الاتصال. |
champrep contacts update CONTACT_ID |
تحديث بيانات التعريف الخاصة بجهات الاتصال. |
champrep contacts rm CONTACT_ID |
حذف جهة اتصال. |
courses يقبل أيضًا learn الاسم المستعار.
| الأمر | الغرض |
|---|---|
champrep courses ls |
عرض قائمة بالدورات التدريبية المتاحة. |
champrep courses enrolled |
عرض قائمة بالتسجيلات الحالية للمستخدم النشط. |
champrep courses read COURSE_ID |
عرض مقرر دراسي واحد. |
champrep courses sections COURSE_ID |
عرض أقسام المقرر الدراسي. |
| الأمر | الغرض |
|---|---|
champrep notes ls |
عرض قائمة بالملاحظات الحديثة. |
champrep notes create |
إنشاء ملاحظة. |
champrep notes read NOTE_ID |
طباعة ملاحظة. |
champrep notes edit NOTE_ID |
تحديث عنوان الملاحظة و/أو نصها. |
champrep notes rm NOTE_ID |
حذف ملاحظة. |
CHAMPREP AI
Section titled “CHAMPREP AI”| الأمر | الغرض |
|---|---|
champrep ai chat [PROMPT] |
طرح سؤال لمرة واحدة أو بدء جلسة تفاعلية. |
champrep ai summarize |
تلخيص ملف. |
champrep ai conversations |
عرض قائمة بالمحادثات المحفوظة. |
champrep ai read CONVERSATION_ID |
قراءة محادثة. |
champrep ai rm CONVERSATION_ID |
حذف محادثة. |
champrep ai usage |
عرض الاستخدام الحالي للذكاء الاصطناعي. |
مراجعة مخرجات الذكاء الاصطناعي المهمة قبل الاعتماد عليها.
| الأمر | الغرض |
|---|---|
champrep meet create |
إنشاء غرفة اجتماعات. |
champrep meet ls |
عرض قائمة الاجتماعات. |
champrep meet join MEETING_ID |
فتح اجتماع في المتصفح الافتراضي. |
Calendar
Section titled “Calendar”calendar يقبل أيضًا cal الاسم المستعار.
| الأمر | الغرض |
|---|---|
champrep calendar today |
عرض أحداث اليوم. |
champrep calendar week |
عرض أحداث هذا الأسبوع. |
champrep calendar create |
إنشاء حدث. |
champrep calendar rm EVENT_ID |
حذف حدث. |
ابحث عن كل ما يمكن لبيانات اعتمادك الوصول إليه في استعلام واحد. يتم تجميع النتائج حسب الخدمة، ويتم سرد أي عناصر تم تخطيها مع ذكر السبب.
| الأمر | الغرض |
|---|---|
champrep search QUERY |
ابحث عبر جميع خدماتك. |
champrep search services |
اعرض الخدمات التي يمكنك البحث فيها، وما إذا كان البحث باستخدام الذكاء الاصطناعي متاحًا. |
| العلامة | الغرض |
|---|---|
-s, --service |
تحديد الخدمة (قابل للتكرار). يحافظ على تكلفة الاستعلام منخفضة. |
--limit |
الحد الأقصى لعدد النتائج لكل خدمة (الافتراضي 5، بحد أقصى 20). |
--ai |
تصنيف النتائج باستخدام الذكاء الاصطناعي والحصول على إجابة موجزة. يستخدم رصيد الذكاء الاصطناعي الخاص بك. |
champrep search "q3 roadmap"champrep search "invoice 1042" --service invoice --service mailchamprep search "what did we decide about pricing" --aiتكلف عملية البحث وحدة واحدة من حد المعدل لكل خدمة تم البحث فيها فعليًّا، لذا فإن تضييق نطاق البحث باستخدام --service هي الطريقة الأرخص للحفاظ على استجابة النظام. --ai يستهلك رصيد الذكاء الاصطناعي الشهري الخاص بك؛ وبدون رصيد، يظل الأمر يعرض النتائج العادية ويوضح لك سبب عدم تشغيل تصنيف الذكاء الاصطناعي.
| الأمر | الغرض |
|---|---|
champrep work boards |
عرض لوحاتك. |
champrep work board BOARD_ID |
عرض مجلس إدارة واحد. |
champrep work tickets |
عرض قائمة التذاكر. التصفية باستخدام --board, --status, --search, --mine. |
champrep work ticket TICKET |
عرض تذكرة واحدة حسب المعرّف أو المفتاح (على سبيل المثال ENG-7). |
champrep work create |
إنشاء تذكرة (--board, --title, --priority, --type). |
champrep work tickets --minechamprep work create --board 642f... --title "Fix login" --priority high --type bugInvoice
Section titled “Invoice”| الأمر | الغرض |
|---|---|
champrep invoice ls |
عرض قائمة بالفواتير. التصفية باستخدام --status. |
champrep invoice read INVOICE_ID |
عرض فاتورة واحدة. |
champrep invoice issue INVOICE_ID |
إصدار مسودة (من مسودة إلى صادرة). |
champrep invoice send INVOICE_ID |
إرسال فاتورة عبر البريد الإلكتروني (--to (عندما لا يوجد مستلم مسجل في السجل). |
champrep invoice rm INVOICE_ID |
حذف مسودة. |
يستهلك إصدار الفواتير وإرسالها رصيد إرسال الفواتير المخصص لخطتك، لذا فإن هذه العمليات تتطلب
invoice:send نطاق على APIمفتاح API.
| الأمر | الغرض |
|---|---|
champrep forms ls |
عرض قائمة بالنماذج الخاصة بك. |
champrep forms read FORM_ID |
عرض نموذج واحد. |
champrep forms responses FORM_ID |
عرض قائمة ردود النموذج. |
champrep forms create |
إنشاء نموذج (--title, --description, --publish). |
champrep forms publish FORM_ID |
نشر نموذج مسودة. |
champrep forms rm FORM_ID |
نقل نموذج إلى سلة المهملات. |
الهيكل التنظيمي
Section titled “الهيكل التنظيمي”| الأمر | الغرض |
|---|---|
champrep charts me |
عرض منصبك في المخطط التنظيمي. |
champrep charts tree |
طباعة المخطط التنظيمي بتنسيق JSON. |
champrep charts search QUERY |
البحث عن الأشخاص في المؤسسة. |
champrep charts profile USER_ID |
طباعة ملف تعريف شخص ما بتنسيق JSON. |
الأعمال
Section titled “الأعمال”إدارة المؤسسة (الشركة). تستخدم عمليات القراءة business:read النطاق.
| الأمر | الغرض |
|---|---|
champrep business info |
عرض مؤسستك ودورك فيها. |
champrep business members |
عرض قائمة بأعضاء المؤسسة. |
champrep business usage |
عرض إحصائيات استخدام المؤسسة. |
الحساب والاستخدام
Section titled “الحساب والاستخدام”| الأمر | الغرض |
|---|---|
champrep account |
عرض هويتك، وخطة الاشتراك، وحد الاستخدام الفعلي، والاستخدام اليومي، واستخدام سعة التخزين. |
champrep accountchamprep account --json
API المفاتيح
Section titled “API المفاتيح”إدارة cpk_... المفاتيح المستخدمة للوصول بدون واجهة مستخدم و CI. تتطلب هذه الأوامر جلسة متصفح تفاعلية (تشغيل champrep auth login أولاً، وليس
auth token). يؤدي إنشاء مفتاح أو تدويره إلى طباعة السر مرة واحدة.
| الأمر | الغرض |
|---|---|
champrep keys ls |
عرض قائمة APIبمفاتيحك. |
champrep keys create |
إنشاء مفتاح (--name، قابل للتكرار --scope, --expires-in-days, --allowed-ip). |
champrep keys get KEY_ID |
عرض تفاصيل مفتاح واحد. |
champrep keys audit KEY_ID |
عرض سجل التدقيق الأخير لمفتاح ما. |
champrep keys update KEY_ID |
تغيير الاسم أو النطاقات أو قائمة عناوين IP المسموح بها أو --active/--inactive. |
champrep keys regenerate KEY_ID |
تغيير السر (يتوقف السر القديم عن العمل). |
champrep keys revoke KEY_ID |
حذف مفتاح. |
champrep keys create --name "CI deploy" --scope drive:read --scope drive:writechamprep keys create --name "read-only" --scope '*' --expires-in-days 90
الفوترة
Section titled “الفوترة”عرض للاشتراك الخاص بك للقراءة فقط. تغيير الخطط في لوحة تحكم الفوترة.
| الأمر | الغرض |
|---|---|
champrep billing subscription |
عرض اشتراكك الحالي (الاسم المستعار sub). |
champrep billing cards |
عرض قائمة طرق الدفع المحفوظة. |
champrep billing receipts |
عرض قائمة بالإيصالات السابقة. |
Webhooks
Section titled “Webhooks”إدارة اشتراكات webhook الصادرة. يستخدم webhooks:manage النطاق.
| الأمر | الغرض |
|---|---|
champrep webhooks ls |
قم بإدراج webhooks الخاصة بك. |
champrep webhooks events |
قائمة بأنواع الأحداث التي يمكنك الاشتراك فيها. |
champrep webhooks create |
إنشاء ويبهوك (--url، قابلة للتكرار --event). يُعرض سر التوقيع مرة واحدة. |
champrep webhooks rotate WEBHOOK_ID |
قم بتدوير سر التوقيع. |
champrep webhooks rm WEBHOOK_ID |
حذف ويبهوك. |
التكوين المحلي والأدوات
Section titled “التكوين المحلي والأدوات”لا تحتاج هذه الأوامر إلى طلب خدمة ما لم يذكر نص المساعدة الخاص بها خلاف ذلك.
| الأمر | الغرض |
|---|---|
champrep config get KEY |
قراءة قيمة التكوين. |
champrep config set KEY VALUE |
تعيين قيمة تكوين مسموح بها. |
champrep config list |
اطبع التكوين الحالي. |
champrep config path |
اطبع مسار ملف التكوين. |
champrep config env [NAME] |
عرض أو تعيين البيئة الافتراضية. |
champrep completion SHELL |
إنشاء إكمال لـ Bash أو Zsh أو Fish أو PowerShell. |
champrep version |
نسخة الطباعة، والتثبيت، وتاريخ البناء، ومعلومات وقت التشغيل. |
لا يتم تخزين الرموز المميزة في ملف التكوين. لا تحاول كتابة رمز مصادقة باستخدام config set.
رموز الخروج
Section titled “رموز الخروج”| الرمز | المعنى |
|---|---|
0 |
النجاح. |
1 |
فشل عام أو فشل في الاستخدام. |
3 |
المصادقة مطلوبة أو غير صالحة. |
4 |
تفتقر بيانات الاعتماد إلى النطاق المطلوب. |
5 |
تم الوصول إلى حد بوابة مباشر. |
6 |
فشل الشبكة. |
7 |
فشل البوابة أو الخدمة. |
يجب أن تتحقق البرامج النصية من رمز الخروج وتقوم بتحليل --json عندما يكون متاحًا. لا تعتبر جمل الأخطاء المقروءة بواسطة البشر واجهة ثابتة.
حدود المعدل
Section titled “حدود المعدل”تحتوي كل استجابة من البوابة على حدودك الحالية. يقوم بإعادة المحاولة بشكل شفافCLI عند الوصول إلى الحد القصير للدقائق، مع الالتزام بـ Retry-After. وهي تقوم لا لا تدخل في حالة سكون عند بلوغ الحد اليومي أو أي انتظار أطول من بضع ثوانٍ — بل تخرج مع رمز 5 وتبلغ عن مدة الانتظار بالضبط، بحيث تفشل البرامج النصية بسرعة. تحقق من عداداتك الحية في أي وقت باستخدام champrep account.