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

تخصيص وكيل الذكاء الاصطناعي

كل ما يظهر في هذه الصفحة هو ملف محلي. الملفات الموجودة ضمن .champrep/ في مستودع يتم مشاركتها مع فريقك عبر git؛ الملفات الموجودة ضمن $CONFIG/ai/ تنطبق عليك فقط، في كل مشروع. عندما يكون للمشروع وتعريف المستخدم نفس الاسم، فإن تعريف المشروع هو الذي يسود.

محتوى المشروع في .champrep/ يظل غير نشط حتى تثق في المستودع. انظر ثقة المستودع.

تعليمات المشروع: CHAMPREP.md

Section titled “تعليمات المشروع: CHAMPREP.md”

CHAMPREP.md يحتوي على تعليمات دائمة للوكيل: كيفية إنشاء واختبار المشروع، والاتفاقيات، والأمور التي يجب تجنبها. يقرأ الوكيل، في بداية كل جلسة:

  • $CONFIG/ai/CHAMPREP.md، تعليماتك الشخصية لكل مشروع؛
  • CHAMPREP.md في جذر المشروع وفي كل دليل بدءًا من الجذر وصولًا إلى المكان الذي بدأت فيه تشغيل الوكيل.

إذا كان الدليل لا يحتوي على CHAMPREP.md، وهو AGENTS.md يُستخدم هناك بدلاً من ذلك.

الإجراءكيف
إنشاء واحد/init يبحث في المستودع ويكتب CHAMPREP.md، مع الاحتفاظ بالمحتوى المفيد من ملف موجود AGENTS.md.
إضافة ملاحظةابدأ موجهًا بـ #، على سبيل المثال # run make lint before committing.
عرض أو تعديل/memory، أو /memory edit [user|project|FILE] لفتحه في محررك.

تنطبق ذاكرة CHAMPREP AIحسابك، التي تُدار في CHAMPREP AIإعداداتك على الويب، في المحطة الطرفية أيضًا. /memory يظهره على أنه للقراءة فقط.

الأمر المخصص هو قالب موجه Markdown تقوم بتشغيله كـ /<name>.

الموقعالنطاق
.champrep/commands/NAME.mdهذا المشروع
$CONFIG/ai/commands/NAME.mdأنت

ملف في مجلد فرعي، مثل commands/git/commit.md، يصبح /git:commit. قم بإنشاء واحدة باستخدام /commands new NAME وإدراجها باستخدام /commands.

---
description: Explain a failing test and propose a fix
argument-hint: <test name>
allowed-tools: [local_read_file, local_grep, local_bash]
---
Find the test named $1, run it, and explain why it fails.
Relevant notes: @docs/testing.md
Recent changes:
!`git log --oneline -5`
  • $ARGUMENTS هو كل ما يلي اسم الأمر؛ $1, $2، … هي معلمات فردية. إذا لم يستخدم القالب أيًا منهما، تُلحق المعلمات.
  • @path يتضمن ملف مساحة العمل. لا يتم تضمين الملفات السرية أبدًا.
  • !`command` يُشغّل أمرًا عند استدعاء القالب. يُطلب منك الموافقة على ذلك مرة واحدة لكل قالب، ومرة أخرى كلما تغير.
  • allowed-tools يحد من الأدوات المتاحة لتلك الدورة، و model يلغي النموذج.

المهارة هي مجلد يحتوي على تعليمات وملفات داعمة اختيارية، لا يقوم الوكيل بتحميلها إلا عند الحاجة إليها. وحتى ذلك الحين، لا يرى النموذج سوى اسم المهارة ووصفها، لذا فإن العديد من المهارات لا تتطلب سوى القليل جدًا من السياق.

الموقعالنطاق
.champrep/skills/NAME/SKILL.mdهذا المشروع
$CONFIG/ai/skills/NAME/SKILL.mdأنت
---
description: Release checklist for this service
when_to_use: When the user asks to cut, tag, or publish a release
---
1. Confirm the changelog has an entry for the new version.
2. ...

/skills تسرد المهارات، بما في ذلك المهارات من CHAMPREP AIحسابك. قم بتشغيل واحدة مباشرةً باستخدام /<skill-name>.

الوكيل المخصص هو وكيل فرعي له تعليماته وأدواته ونموذجه الخاص.

الموقعالنطاق
.champrep/agents/NAME.mdهذا المشروع
$CONFIG/ai/agents/NAME.mdأنت
---
name: test-writer
description: Writes and fixes unit tests. Use after a code change.
tools: [local_read_file, local_grep, local_glob, local_edit_file, local_bash]
permission_mode: accept-edits
isolation: worktree
---
You write focused unit tests that follow this project's existing style.
  • description يُعلم الوكيل الرئيسي بموعد تفويض المهمة إليه.
  • tools يحدد الأدوات؛ اتركه فارغًا ليرث أدوات الجلسة.
  • permission_mode يمكن فقط جعل الوكيل أكثر صرامة من جلستك.
  • isolation: worktree يُشغّلها في شجرة عمل git الخاصة بها.

إدارة الوكلاء باستخدام /agents create|edit|delete NAME. ابدأ جلسة بصفتك وكيلًا باستخدام champrep ai --agent NAME، أو أرسل له موجهًا باستخدام @NAME prompt. انظر الوكلاء الفرعيون.

الخطافات هي أوامر شل يقومCLI بها في نقاط معينة خلال الجلسة، على سبيل المثال لتنسيق الملفات بعد التعديل أو لمنع أوامر معينة.

الحدثيتم التشغيل
SessionStartعند بدء الجلسة.
UserPromptSubmitقبل إرسال موجه. يمكن حظره أو إضافة سياق.
PreToolUseقبل تشغيل أداة محلية. يمكن حظرها.
PostToolUseبعد تشغيل أداة محلية. يمكن إضافة تعليقات على النتيجة.
PermissionRequestعند عرض موجه طلب الإذن.
Notificationمتى يخطرك الوكيل.
SubagentStopعندما ينتهي وكيل فرعي.
PreCompactقبل ضغط المحادثة.
Stopعند انتهاء الدور.
SessionEndعند انتهاء الجلسة.

تكوين الخطافات في أي ملف إعدادات:

{
"hooks": {
"PostToolUse": [
{ "matcher": "local_edit_file|local_write_file", "command": "npm run format --silent", "timeout": 30 }
],
"PreToolUse": [
{ "matcher": "local_bash", "command": "./scripts/check-command.sh" }
]
}
}
  • matcher هو تعبير عادي على اسم الأداة؛ اتركه فارغًا لمطابقة كل الأداوت.
  • يتلقى الـhook وصفًا بتنسيق JSON للحدث عبر المدخلات القياسية.
  • رمز الخروج 2، أو إخراج JSON باستخدام "decision": "block" و reason، يوقف الإجراء حيثما يسمح الحدث بذلك. additionalContext في JSON يضيف الإخراج نصًا للنموذج.
  • المهلة الافتراضية هي 60 ثانية، والحد الأقصى هو 10 دقائق.
  • يتم تشغيل الروابط باستخدام بيئتك باستثناء بياناتCHAMPREP الاعتماد.

إدارة الخطافات باستخدام /hooks, /hooks add EVENT [--matcher M] [--timeout S] [--scope user|project] -- COMMAND, /hooks disable ID، و /hooks enable ID.

الأمرالخيارات
/colorلون تمييز لجلسات هذا المشروع، لتمييز الجلسات المتوازية عن بعضها: blue, cyan, green, yellow, orange, red, pink, magenta, purple, gray، أو reset.
/themeauto, dark, light, high-contrast، أو colorblind. NO_COLOR و --no-color إيقاف تشغيل الألوان.
/statuslineاختر أجزاء من profile, model, context, branch, mode, cost، و tasks؛ استخدم /statusline command CMD لعرض السطر الأول من إخراج الأمر الخاص بك؛ /statusline reset يستعيد الإعدادات الافتراضية.
/output-styledefault, concise, explanatory، أو learning.
/vimالتحرير بنمط Vim في موجه الأوامر.
/keybindingsعرض الاختصارات؛ /keybindings edit يفتح $CONFIG/ai/keybindings.json.
/configكل ما سبق في شاشة واحدة.

تُخزّن محادثات الوكيل على CHAMPREP AIحسابك. يتم تخزين الحالة الخاصة بالجهاز فقط محليًّا. اطبع كل موقع على جهازك باستخدام:

Terminal window
champrep ai paths
ماذاأين
CLI ملفات التعريف والبيئات$CONFIG/config.toml
إعدادات الوكيل الخاص بك: القواعد، الوضع، السمة، سطر الحالة، الخطافات$CONFIG/ai/settings.json
تجاوزات ربط المفاتيح$CONFIG/ai/keybindings.json
تعليماتك الشخصية$CONFIG/ai/CHAMPREP.md
وكلاؤك وأوامرك ومهاراتك$CONFIG/ai/agents/, commands/, skills/
خوادم MCP المحلية الخاصة بك$CONFIG/ai/mcp.json
المشاريع الموثوقة$CONFIG/ai/trusted-projects.json
المحادثات الحديثة لكل دليل، وقوائم المهام$STATE/ai/sessions.json
سجل المطالبات (محجوب ومحدود)$STATE/ai/history.jsonl
سجلات التصحيح (محجوبة، تُحتفظ بها لمدة 7 أيام)$STATE/ai/logs/
نقاط فحص الملفات$CACHE/ai/checkpoints/
إعدادات المشروع (قابلة للتسجيل).champrep/settings.json, mcp.json, agents/, commands/, skills/
تجاوزات مشروعك (المهملة في git).champrep/settings.local.json
تعليمات المشروعCHAMPREP.md
أشجار العمل.champrep/worktrees/

لا يتم تخزين بيانات الاعتماد أبدًا في هذه الملفات. بل تظل مخزنة في سلسلة المفاتيح الخاصة بنظام التشغيل.

الجذرmacOS و Linuxويندوز
$CONFIG$XDG_CONFIG_HOME/champrep، وإلا ~/.config/champrep%APPDATA%\champrep
$STATE$XDG_STATE_HOME/champrep، وإلا ~/.local/state/champrep%LOCALAPPDATA%\champrep\state
$CACHE$XDG_CACHE_HOME/champrep، وإلا ~/.cache/champrep%LOCALAPPDATA%\champrep\cache

تعيين CHAMPREP_CONFIG_DIR للحفاظ على الثلاثة جميعًا في دليل واحد، في config/, state/، و cache/ المجلدات الفرعية. وهذا مفيد للتثبيتات القابلة للنقل و عمليات CI المعزولة.