تخطَّ إلى المحتوى
Documentation

CLI مرجع الأوامر

تشغيل champrep --help و champrep COMMAND --help للحصول على المعلمات الدقيقة المضمنة في الإصدار المثبت. تلخص هذه الصفحة شجرة الأوامر العامة الحالية.

العلامةالغرض
--env NAMEتجاوز بيئة البوابة النشطة لأمر واحد.
--profile IDاستخدام حساب مخزّن آخر لأمر واحد دون تغيير الحساب النشط.
-v, --verboseتسجيل بيانات تعريف الطلب والاستجابة مع حجب رأس التفويض.
--debugإضافة نصوص الطلب والاستجابة إلى مخرجات التشخيص. استخدم بحذر عند التعامل مع البيانات الحساسة.
--jsonإصدار JSON قابل للقراءة آليًّا حيثما كان ذلك مدعومًا.
--no-colorتعطيل ألوان ANSI. كما يلتزم البرنامج أيضًاCLI بـ NO_COLOR.

وضع العلامات الدائمة قبل أو بعد أمر فرعي وفقًا لما يقبله الإصدار المثبت. تفضيل --json لأغراض الأتمتة.

الأمرالغرض
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عرض مساحة التخزين المستخدمة والمتاحة.

أمثلة:

Terminal window
champrep drive ls /
champrep drive tree /projects
champrep drive cp ./report.pdf /reports/report.pdf
champrep drive cp /reports/report.pdf ./report.pdf
champrep drive quota --json
الأمرالغرض
champrep mail lsعرض قائمة بالرسائل الموجودة في مجلد صندوق البريد.
champrep mail read MESSAGE_IDطباعة رسالة واحدة.
champrep mail sendأرسل رسالة. --subject مطلوب؛ لإرساله بدونه، قم بحذفه وتجاوزه --no-subject.
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إنشاء غرفة.
الأمرالغرض
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انقل الملاحظة إلى سلة المهملات. استعدها في غضونCHAMPREPNotes 30 يومًا؛ ثم يتم مسحها تلقائيًا. يمكن قراءة الملاحظة الموجودة في سلة المهملات ولكن لا يمكن تحريرها.
الأمرالغرض
eve أو champrep aiبدء تشغيل وكيل البرمجة التفاعلية بالذكاء الاصطناعي Eve في الدليل الحالي.
champrep eveاسم مستعار لـ champrep ai / eve.
eve -p PROMPT أو champrep ai -p PROMPTتشغيل الوكيل بدون واجهة مستخدم لمرة واحدة لعرض موجه واحد وطباعة الإجابة.
champrep ai models lsسرد نماذج المنصة والنماذج التي قمت بتسجيلها باستخدام مفتاحك الخاص.
champrep ai models registerتسجيل نموذج يستخدم APIمفتاح المزود الخاص بك.
champrep ai models rm NAMEإزالة نموذج مسجل ومفتاحه.
champrep ai pathsاطبع كل الملفات والمجلدات المحلية التي يستخدمها الوكيل.
champrep ai chat [PROMPT]طرح سؤال لمرة واحدة أو بدء جلسة تفاعلية.
champrep ai summarizeتلخيص ملف.
champrep ai conversationsعرض قائمة بالمحادثات المحفوظة.
champrep ai read CONVERSATION_IDقراءة محادثة.
champrep ai rm CONVERSATION_IDحذف محادثة.
champrep ai usageعرض الاستخدام الحالي للذكاء الاصطناعي.

مراجعة مخرجات الذكاء الاصطناعي المهمة قبل الاعتماد عليها.

للاطلاع على أوامر الوكيل التي تبدأ بشرطة مائلة، والأذونات، والخيارات، انظر وكيل الذكاء الاصطناعي: Eve (champrep ai / eve).

الأمرالغرض
champrep meet createإنشاء غرفة اجتماعات.
champrep meet lsعرض قائمة الاجتماعات.
champrep meet join MEETING_IDفتح اجتماع في المتصفح الافتراضي.

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تصنيف النتائج باستخدام الذكاء الاصطناعي والحصول على إجابة موجزة. يستخدم رصيد الذكاء الاصطناعي الخاص بك.
Terminal window
champrep search "q3 roadmap"
champrep search "invoice 1042" --service invoice --service mail
champrep search "what did we decide about pricing" --ai

تكلف عملية البحث وحدة واحدة من حد المعدل لكل خدمة تم البحث فيها فعليًّا، لذا فإن تضييق نطاق البحث باستخدام --service هي الطريقة الأرخص للحفاظ على استجابة النظام. --ai يستهلك رصيد الذكاء الاصطناعي الشهري الخاص بك؛ وبدون رصيد، يظل الأمر يعرض النتائج العادية ويوضح لك سبب عدم تشغيل تصنيف الذكاء الاصطناعي.

الأمرالغرض
champrep work boardsعرض لوحاتك.
champrep work board BOARD_IDعرض مجلس إدارة واحد.
champrep work ticketsقائمة التذاكر. تصفية باستخدام --board, --status (معرف الحالة، أو مع --board اسم الحالة)، --search, --mine; --limit 1 إلى 200.
champrep work ticket TICKETعرض تذكرة واحدة حسب المعرّف أو المفتاح (على سبيل المثال ENG-7).
champrep work createإنشاء تذكرة (--board, --title, --priority, --type).
Terminal window
champrep work tickets --mine
champrep work create --board 642f... --title "Fix login" --priority high --type bug
الأمرالغرض
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نقل نموذج إلى سلة المهملات.

الأمرالغرض
champrep charts meعرض منصبك في المخطط التنظيمي.
champrep charts treeطباعة المخطط التنظيمي بتنسيق JSON.
champrep charts search QUERYالبحث عن الأشخاص في المؤسسة.
champrep charts profile USER_IDطباعة ملف تعريف شخص ما بتنسيق JSON.

إدارة المؤسسة (الشركة). تستخدم عمليات القراءة business:read النطاق.

الأمرالغرض
champrep business infoعرض مؤسستك ودورك فيها.
champrep business membersعرض قائمة بأعضاء المؤسسة.
champrep business usageعرض إحصائيات استخدام المؤسسة.

المشاريع، والفروع، وطلبات الدمج، والمشكلات، وخطوط الإنتاج، وسجلات المهام، والإصدارات. PROJECT هو المسار الكامل للمشروع (acme/web) أو معرّفها. المرجع الكامل: CHAMPREP أوامر الكود.

الأمرالغرض
champrep code projects ls / show / createسرد المشاريع وعرضها وإنشاؤها.
champrep code repo clone-url PROJECTطباعة عنوان النسخة (--ssh (لـ SSH).
champrep code cloneاستنساخ المشاريع، مجموعة (--group, --include-subgroups) أو كلها خاصة بك (--membership, --owned, --all) في شجرة مساحة الأسماء؛ --update يحافظ على تحديثها.
champrep code branches ls PROJECTسرد الفروع.
champrep code mr ls / show / create / merge / approveWork مع طلبات الدمج.
champrep code issues ls / show / create / close / reopenWork التي تحتوي على مشكلات.
champrep code pipelines ls / show / run / retry / cancelWork مع مسارات العمل.
champrep code pipelines wait PROJECT [ID]انتظر خط أنابيب، أحدث إصدار من الالتزام (--sha)، أو أحدث إصدار على --ref للإنهاء؛ الخروج 0 عند النجاح، 1 وإلا، 8 على --timeout.
champrep code jobs ls / log / play / retryسرد المهام، أو طباعتها أو متابعتها (--follow) سجل، وبدء المهام اليدوية.
champrep code releases ls PROJECTسرد الإصدارات.
champrep code runners ls / show / update / createقائمة المُشغِّلات ومن هو متصل، وتغيير العلامات، والإيقاف المؤقت والاستئناف، وإنشاء مُشغِّل.
champrep code ssh-keys lsأدرج مفاتيح SSH الخاصة بك لاستخدام git عبر SSH.
Terminal window
champrep code clone --group acme --include-subgroups --dest ~/src --ssh
champrep code mr ls acme/web
champrep code pipelines run acme/web --ref main --yes
champrep code jobs log acme/web 4182 --follow

توجد الوصفات لكل مهمة على حدة لـ Code و Runner Farm و QA، بما في ذلك استخدام CI، في المهام الشائعة.

runner-farm يقبل أيضًا rf اسم مستعار. --workspace يختار حساب المزرعة (personal, organization:<id>, team:<id>). المرجع الكامل: أوامر مزرعة المشغلات.

الأمرالغرض
champrep rf accounts ls / showسرد حسابات المزرعة التي يمكنك العمل من خلالها؛ عرض حساب واحد.
champrep rf connections lsسرد اتصالات مضيف الكود.
champrep rf pools ls / show / create / updateإدارة مجموعات المشغلات، بما في ذلك --pause و --resume.
champrep rf usageالرصيد والدقائق للفترة الحالية.
champrep rf jobs lsسرد المهام، بما في ذلك المهام المعلقة والمؤجلة.
Terminal window
champrep rf pools ls
champrep rf usage

المستودعات، وعمليات الفحص، والنتائج، وبوابات الجودة، والمعاينات، ومساحات عمل IDE. REPO هو مفتاح مستودع مثل code:<project-uuid>. المرجع الكامل: CHAMPREP QA الأوامر.

الأمرالغرض
champrep qa repos ls / available / activate / deactivate / syncإدارة تحليلات ضمان الجودة للمستودعات.
champrep qa scan REPOبدء عملية مسح؛ --watch يتابعها حتى النهاية.
champrep qa scans ls / showسرد وعرض عمليات الفحص.
champrep qa findings ls / show / dismiss / reopenتصفية (--severity, --cwe, --branch, --state) وتصنيف النتائج.
champrep qa gates status REPOعرض نتيجة بوابة الجودة؛ الخروج 1 عند الفشل.
champrep qa previews ls / show / create / extend / stopإدارة بيئات المعاينة.
champrep qa ide ls / start / open / stopإدارة مساحات عمل بيئة تطوير سحابية (IDE).
Terminal window
champrep qa scan code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --watch --yes
champrep qa findings ls --severity critical,high

في هذه المجموعات الثلاث، الأوامر التي تُحدث تغييرًا أو تستخدم دقائق CI، أو أرصدة، أو الحصص تطلب أولاً: code mr create, mr merge, mr approve, issues close و reopen، كل خط أنابيب وإجراء مهمة، rf pools create و update، وكل qa الكتابة (repos activate و deactivate, scan, findings dismiss و reopen, previews create, extend و stop, ide start و stop). تمرير --yes (-y) في البرامج النصية؛ بدون محطة طرفية و بدون --yes، ولا يغيران شيئًا. لا يُطلب منك ذلك عند إنشاء مشروع Code أو مشكلة . --workspace على rf و qa يختار الحساب المستخدم و الذي تُفرض عليه الرسوم.

الأمرالغرض
champrep accountعرض هويتك، وخطة الاشتراك، وحد الاستخدام الفعلي، والاستخدام اليومي، واستخدام سعة التخزين.
Terminal window
champrep account
champrep account --json

إدارة 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حذف مفتاح.
Terminal window
champrep keys create --name "CI deploy" --scope drive:read --scope drive:write
champrep keys create --name "read-only" --scope '*' --expires-in-days 90

عرض للاشتراك الخاص بك للقراءة فقط. تغيير الخطط في لوحة تحكم الفوترة.

الأمرالغرض
champrep billing subscriptionعرض اشتراكك الحالي (الاسم المستعار sub).
champrep billing cardsعرض قائمة طرق الدفع المحفوظة.
champrep billing receiptsعرض قائمة بالإيصالات السابقة.

إدارة اشتراكات 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قم بتعيين قيمة تكوين مسموح بها. api_url أو web_url يجب أن يكون https:// .
champrep config listاطبع التكوين الحالي. باستخدام --json المفاتيح هي الخاصة بالملف (default_environment, api_url …).
champrep config pathاطبع مسار ملف التكوين.
champrep config env [NAME]عرض أو تعيين البيئة الافتراضية.
champrep completion SHELLإنشاء إكمال لـ Bash أو Zsh أو Fish أو PowerShell.
champrep versionنسخة الطباعة، والتثبيت، وتاريخ البناء، ومعلومات وقت التشغيل.

لا يتم تخزين الرموز المميزة في ملف التكوين. لا تحاول كتابة رمز مصادقة باستخدام config set.

الرمزالمعنى
0النجاح.
1خطأ عام أو متعلق بالاستخدام، أو رفض لا يمكن إصلاحه بتسجيل الدخول مرة أخرى: عدم إمكانية الوصول إلى العنصر، أو عدم توفره في خطتك، أو الحاجة إلى الدفع أو الرصيد، أو دورك، أو قرار يتطلب جلسة الويب الخاصة بك.
3المصادقة مطلوبة أو غير صالحة.
4تفتقر بيانات الاعتماد إلى النطاق المطلوب.
5تم الوصول إلى حد بوابة مباشر.
6فشل الشبكة.
7فشل البوابة أو الخدمة.
8انتهى وقت الانتظار: code pipelines wait --timeout.

يجب أن تتحقق البرامج النصية من رمز الخروج وتقوم بتحليل --json عندما يكون متاحًا. لا تعتبر جمل الأخطاء المقروءة بواسطة البشر واجهة ثابتة.

تحتوي كل استجابة من البوابة على حدودك الحالية. يقوم بإعادة المحاولة بشكل شفافCLI عند الوصول إلى الحد القصير للدقائق، مع الالتزام بـ Retry-After. وهي تقوم لا لا تدخل في حالة سكون عند بلوغ الحد اليومي أو أي انتظار أطول من بضع ثوانٍ — بل تخرج مع رمز 5 وتبلغ عن مدة الانتظار بالضبط، بحيث تفشل البرامج النصية بسرعة. تحقق من عداداتك الحية في أي وقت باستخدام champrep account.