CLI commands

مستندات

`openclaw docs`

فهرست زنده مستندات OpenClaw را از ترمینال جست‌وجو کنید.

نحوه استفاده

bash

openclaw docs                       # نمایش نقطه ورود مستندات و نمونه جست‌وجوopenclaw docs <query...>            # جست‌وجوی فهرست زنده مستندات

آرگومان	توضیحات
`[query...]`	عبارت جست‌وجوی آزاد. عبارت‌های چندواژه‌ای با فاصله به هم متصل و به‌صورت یک عبارت ارسال می‌شوند.

در صورت نبود عبارت جست‌وجو، openclaw docs به‌جای اجرای جست‌وجو، URL نقطه ورود مستندات و یک فرمان جست‌وجوی نمونه را نمایش می‌دهد.

مثال‌ها

bash

openclaw docs browser existing-sessionopenclaw docs sandbox allowHostControlopenclaw docs gateway token secretref

نحوه کار

openclaw docs، https://docs.openclaw.ai/api/search را فراخوانی و نتایج JSON را نمایش می‌دهد. درخواست جست‌وجو از مهلت زمانی ثابت 30 ثانیه‌ای استفاده می‌کند.

خروجی

در یک ترمینال غنی (TTY)، نتایج به‌شکل یک عنوان و سپس فهرستی گلوله‌ای نمایش داده می‌شوند: عنوان صفحه، URL پیوندشده مستندات و یک گزیده کوتاه در خط بعد. برای نتایج خالی، پیام «نتیجه‌ای یافت نشد.» نمایش داده می‌شود.

در خروجی غیرغنی (ارسال‌شده از طریق پایپ، --no-color، اسکریپت‌ها)، همان داده‌ها به‌صورت Markdown نمایش داده می‌شوند:

markdown

# جست‌وجوی مستندات: <query> - [عنوان](https://docs.openclaw.ai/...) - گزیده- [عنوان](https://docs.openclaw.ai/...) - گزیده

کدهای خروج

کد	معنا
`0`	جست‌وجو با موفقیت انجام شد؛ پاسخ‌های بدون نتیجه را نیز شامل می‌شود.
`1`	فراخوانی API جست‌وجوی مستندات میزبانی‌شده ناموفق بود؛ پیام خطا در stderr نمایش داده می‌شود.

مرتبط

Was this useful?