summaryrefslogtreecommitdiffhomepage
path: root/packages/web/src/content/docs/ar/commands.mdx
blob: da14065212dd443a08505f60bbd4e44ac72c3786 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
---
title: الأوامر
description: أنشئ أوامر مخصصة للمهام المتكررة.
---

تتيح لك الأوامر المخصصة تحديد مُطالبة (prompt) تريد تشغيلها عند تنفيذ ذلك الأمر في واجهة TUI.

```bash frame="none"
/my-command
```

تُعدّ الأوامر المخصصة إضافةً إلى الأوامر المضمنة مثل `/init` و`/undo` و`/redo` و`/share` و`/help`. [اعرف المزيد](/docs/tui#commands).

---

## إنشاء ملفات الأوامر

أنشئ ملفات Markdown داخل الدليل `commands/` لتعريف أوامر مخصصة.

أنشئ الملف `.opencode/commands/test.md`:

```md title=".opencode/commands/test.md"
---
description: Run tests with coverage
agent: build
model: anthropic/claude-3-5-sonnet-20241022
---

Run the full test suite with coverage report and show any failures.
Focus on the failing tests and suggest fixes.
```

تُعرِّف ترويسة Frontmatter خصائص الأمر، بينما يصبح المحتوى هو القالب.

استخدم الأمر بكتابة `/` ثم اسم الأمر.

```bash frame="none"
"/test"
```

---

## الإعداد

يمكنك إضافة أوامر مخصصة عبر إعدادات OpenCode أو بإنشاء ملفات Markdown داخل الدليل `commands/`.

---

### JSON

استخدم خيار `command` في [config](/docs/config) الخاص بـ OpenCode:

```json title="opencode.jsonc" {4-12}
{
  "$schema": "https://opencode.ai/config.json",
  "command": {
    // يصبح هذا اسم الأمر
    "test": {
      // هذه هي المطالبة التي ستُرسل إلى LLM
      "template": "Run the full test suite with coverage report and show any failures.\nFocus on the failing tests and suggest fixes.",
      // يظهر هذا كوصف في TUI
      "description": "Run tests with coverage",
      "agent": "build",
      "model": "anthropic/claude-3-5-sonnet-20241022"
    }
  }
}
```

يمكنك الآن تشغيل هذا الأمر في واجهة TUI:

```bash frame="none"
/test
```

---

### Markdown

يمكنك أيضًا تعريف الأوامر باستخدام ملفات Markdown. ضعها في:

- على مستوى النظام: `~/.config/opencode/commands/`
- لكل مشروع: `.opencode/commands/`

```markdown title="~/.config/opencode/commands/test.md"
---
description: Run tests with coverage
agent: build
model: anthropic/claude-3-5-sonnet-20241022
---

Run the full test suite with coverage report and show any failures.
Focus on the failing tests and suggest fixes.
```

يصبح اسم ملف Markdown هو اسم الأمر. على سبيل المثال، يتيح لك `test.md` تشغيل:

```bash frame="none"
/test
```

---

## إعداد المُطالبة

تدعم مُطالبات الأوامر المخصصة عدة عناصر نائبة (placeholders) وبنى خاصة.

---

### الوسائط

مرِّر وسائط إلى الأوامر باستخدام العنصر النائب `$ARGUMENTS`.

```md title=".opencode/commands/component.md"
---
description: Create a new component
---

Create a new React component named $ARGUMENTS with TypeScript support.
Include proper typing and basic structure.
```

شغِّل الأمر مع وسائط:

```bash frame="none"
/component Button
```

وسيُستبدل `$ARGUMENTS` بالقيمة `Button`.

يمكنك أيضًا الوصول إلى كل وسيط على حدة باستخدام المعاملات الموضعية:

- `$1` - الوسيط الأول
- `$2` - الوسيط الثاني
- `$3` - الوسيط الثالث
- وهكذا...

على سبيل المثال:

```md title=".opencode/commands/create-file.md"
---
description: Create a new file with content
---

Create a file named $1 in the directory $2
with the following content: $3
```

شغِّل الأمر:

```bash frame="none"
/create-file config.json src "{ \"key\": \"value\" }"
```

سيؤدي ذلك إلى استبدال:

- `$1` بـ `config.json`
- `$2` بـ `src`
- `$3` بـ `{ "key": "value" }`

---

### خرج shell

استخدم _!`command`_ لحقن خرج [أمر bash](/docs/tui#bash-commands) داخل مُطالبتك.

على سبيل المثال، لإنشاء أمر مخصص يُحلل تغطية الاختبارات:

```md title=".opencode/commands/analyze-coverage.md"
---
description: Analyze test coverage
---

Here are the current test results:
!`npm test`

Based on these results, suggest improvements to increase coverage.
```

أو لمراجعة التغييرات الأخيرة:

```md title=".opencode/commands/review-changes.md"
---
description: Review recent changes
---

Recent git commits:
!`git log --oneline -10`

Review these changes and suggest any improvements.
```

تُشغَّل الأوامر في دليل جذر مشروعك ويصبح خرجها جزءًا من المُطالبة.

---

### مراجع الملفات

ضمِّن الملفات في أمرك باستخدام `@` ثم اسم الملف.

```md title=".opencode/commands/review-component.md"
---
description: Review component
---

Review the component in @src/components/Button.tsx.
Check for performance issues and suggest improvements.
```

يُدرج محتوى الملف في المُطالبة تلقائيًا.

---

## الخيارات

لنلقِ نظرةً على خيارات الإعداد بالتفصيل.

---

### القالب (`template`)

يُعرِّف خيار `template` المُطالبة التي ستُرسل إلى نموذج اللغة (LLM) عند تنفيذ الأمر.

```json title="opencode.json"
{
  "command": {
    "test": {
      "template": "Run the full test suite with coverage report and show any failures.\nFocus on the failing tests and suggest fixes."
    }
  }
}
```

هذا خيار إعداد **إلزامي**.

---

### الوصف (`description`)

استخدم خيار `description` لتقديم وصف موجز لما يفعله الأمر.

```json title="opencode.json"
{
  "command": {
    "test": {
      "description": "Run tests with coverage"
    }
  }
}
```

يظهر هذا الوصف في واجهة TUI عند كتابة الأمر.

---

### الوكيل (`agent`)

استخدم إعداد `agent` لتحديد أي [agent](/docs/agents) ينبغي أن ينفّذ هذا الأمر (اختياريًا).
إذا كان هذا [subagent](/docs/agents/#subagents)، فسيؤدي الأمر افتراضيًا إلى تشغيل استدعاء subagent.
لإيقاف هذا السلوك، عيِّن `subtask` إلى `false`.

```json title="opencode.json"
{
  "command": {
    "review": {
      "agent": "plan"
    }
  }
}
```

هذا خيار إعداد **اختياري**. إن لم تُحدده، فسيُستخدم agent الحالي افتراضيًا.

---

### مهمة فرعية (`subtask`)

استخدم القيمة المنطقية `subtask` لفرض أن يُشغِّل الأمر استدعاء [subagent](/docs/agents/#subagents).
يفيد هذا إذا أردت ألا يلوّث الأمر السياق الأساسي لديك، إذ سيُجبر (**force**) الـ agent على العمل كـ subagent،
حتى لو كان `mode` مضبوطًا على `primary` في إعدادات [agent](/docs/agents).

```json title="opencode.json"
{
  "command": {
    "analyze": {
      "subtask": true
    }
  }
}
```

هذا خيار إعداد **اختياري**.

---

### النموذج (`model`)

استخدم إعداد `model` لتجاوز النموذج الافتراضي لهذا الأمر.

```json title="opencode.json"
{
  "command": {
    "analyze": {
      "model": "anthropic/claude-3-5-sonnet-20241022"
    }
  }
}
```

هذا خيار إعداد **اختياري**.

---

## الأوامر المضمنة

يتضمن opencode عدة أوامر مضمنة مثل `/init` و`/undo` و`/redo` و`/share` و`/help`؛ [اعرف المزيد](/docs/tui#commands).

:::note
يمكن للأوامر المخصصة تجاوز الأوامر المضمنة.
:::

إذا عرّفت أمرًا مخصصًا بالاسم نفسه، فسيستبدل الأمر المضمن.