> ## Documentation Index
> Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# المستندات

# `openclaw docs`

ابحث في فهرس مستندات OpenClaw المباشرة من الطرفية. يستدعي الأمر واجهة API لبحث المستندات المستضافة على Cloudflare من OpenClaw ويعرض النتائج في طرفيتك.

## الاستخدام

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw docs                       # print docs entrypoint and example search
openclaw docs <query...>            # search the live docs index
```

الوسيطات:

| الوسيطة      | الوصف                                                                                  |
| ------------ | -------------------------------------------------------------------------------------- |
| `[query...]` | استعلام بحث حر الصياغة. تُدمج الاستعلامات متعددة الكلمات بمسافات وتُرسل كاستعلام واحد. |

## أمثلة

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw docs browser existing-session
openclaw docs sandbox allowHostControl
openclaw docs gateway token secretref
```

دون استعلام، يطبع `openclaw docs` عنوان URL لنقطة دخول المستندات إضافة إلى نموذج أمر بحث بدلًا من تشغيل بحث.

## كيف يعمل

يستدعي `openclaw docs` العنوان `https://docs.openclaw.ai/api/search` ويعرض نتائج JSON. تستخدم مكالمة البحث مهلة ثابتة قدرها 30 ثانية.

## الإخراج

في طرفية غنية (TTY)، تُعرض النتائج كعنوان يليه قائمة نقطية. يعرض كل بند عنوان الصفحة، وعنوان URL المرتبط للمستندات، ومقتطفًا قصيرًا في السطر التالي. تطبع النتائج الفارغة "لا توجد نتائج.".

في الإخراج غير الغني (عند التمرير عبر أنبوب، أو `--no-color`، أو السكربتات)، تُعرض البيانات نفسها بصيغة Markdown:

```markdown theme={"theme":{"light":"min-light","dark":"min-dark"}}
# Docs search: <query>

- [Title](https://docs.openclaw.ai/...) - snippet
- [Title](https://docs.openclaw.ai/...) - snippet
```

## رموز الخروج

| الرمز | المعنى                                                                  |
| ----- | ----------------------------------------------------------------------- |
| `0`   | نجح البحث (بما في ذلك الاستجابات ذات النتائج الصفرية).                  |
| `1`   | فشلت مكالمة واجهة API لبحث المستندات المستضافة؛ يُطبع stderr ضمن السطر. |

## ذات صلة

* [مرجع CLI](/ar/cli)
* [المستندات المباشرة](https://docs.openclaw.ai)
