CLI commands

مستندات

`OmeniaClaw docs`

نمایهٔ زندهٔ مستندات OmeniaClaw را از ترمینال جست‌وجو کنید. این دستور برای نقطهٔ پایانی عمومی جست‌وجوی MCP مستندات میزبانی‌شده روی Mintlify در https://omeniaclaw.com/mcp.SearchOmeniaClaw یک فرمان پوسته اجرا می‌کند و نتایج را در ترمینال شما نمایش می‌دهد.

کاربرد

bash

OmeniaClaw docs                       # print docs entrypoint and example searchOmeniaClaw docs <query...>            # search the live docs index

آرگومان‌ها:

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

نمونه‌ها

bash

OmeniaClaw docs browser existing-sessionOmeniaClaw docs sandbox allowHostControlOmeniaClaw docs gateway token secretref

بدون پرس‌وجو، OmeniaClaw docs به‌جای اجرای جست‌وجو، URL نقطهٔ ورود مستندات را همراه با یک دستور جست‌وجوی نمونه چاپ می‌کند.

نحوهٔ کار

OmeniaClaw docs برای فراخوانی ابزار جست‌وجوی MCP مستندات، CLI به نام mcporter را اجرا می‌کند، سپس بلوک‌های Title: / Link: / Content: را از خروجی ابزار به فهرستی از نتایج تبدیل می‌کند.

برای پیدا کردن mcporter، OmeniaClaw به‌ترتیب این موارد را بررسی می‌کند:

mcporter در PATH (اگر وجود داشته باشد مستقیم استفاده می‌شود).
pnpm dlx mcporter ... اگر pnpm نصب باشد.
npx -y mcporter ... اگر npx نصب باشد.

اگر هیچ‌کدام در دسترس نباشند، دستور با راهنمایی برای نصب pnpm (npm install -g pnpm) ناموفق می‌شود.

فراخوانی جست‌وجو از مهلت زمانی ثابت ۳۰ ثانیه‌ای استفاده می‌کند. قطعه‌های نتیجه برای هر ورودی به حدود ۲۲۰ نویسه کوتاه می‌شوند.

خروجی

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

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

markdown

# Docs search: <query> - [Title](https://omeniaclaw.com/...) - snippet- [Title](https://omeniaclaw.com/...) - snippet

کدهای خروج

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

مرتبط

Was this useful?