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

# CLI

> التفاعل مع Gorbit من سطر الأوامر

<img src="https://mintcdn.com/gorbit/qYeWoSrsnkRPFQDm/assets/overview/cli/cli_hero.png?fit=max&auto=format&n=qYeWoSrsnkRPFQDm&q=85&s=613815de57e9f4565a6bbc18f25ac1d9" alt="واجهة طرفية Gorbit CLI" width="1910" height="1076" data-path="assets/overview/cli/cli_hero.png" />

Gorbit CLI هي واجهة طرفية للمحادثة مع وكلاء Gorbit والاستعلام عن قاعدة معرفتك.
مبني بـ Go باستخدام [Bubble Tea](https://github.com/charmbracelet/bubbletea)،
يوفر كلاً من واجهة TUI تفاعلية وأوامر غير تفاعلية للبرمجة والأتمتة.

## التثبيت

### PyPI (موصى به)

```shell theme={null}
pip install gorbit-cli
```

أو مع uv:

```shell theme={null}
uv pip install gorbit-cli
```

<Card title="حزمة PyPI" icon="python" href="https://pypi.org/project/gorbit-cli/">
  pip install gorbit-cli
</Card>

### Go

```shell theme={null}
go install github.com/gorbit-dot-app/gorbit/cli@latest
```

### البناء من المصدر

يتطلب [Go 1.24+](https://go.dev/dl/).

```shell theme={null}
git clone https://github.com/gorbit-dot-app/gorbit.git
cd gorbit/cli
go build -o gorbit-cli .
sudo mv gorbit-cli /usr/local/bin/
```

## الإعداد

شغّل الإعداد التفاعلي لتكوين عنوان URL لخادمك ومفتاح API:

```shell theme={null}
gorbit-cli configure
```

يطالبك هذا بعنوان URL لخادم Gorbit ومفتاح API، ويختبر الاتصال،
ويحفظ التكوين في `~/.config/gorbit-cli/config.json`.

### إنشاء رمز وصول

انتقل إلى **إعدادات المستخدم > الحسابات والوصول > رمز وصول جديد** (`/app/settings/accounts-access`)
لإنشاء رمز وصول لـ CLI.

<img src="https://mintcdn.com/gorbit/qYeWoSrsnkRPFQDm/assets/overview/cli/access_tokens.png?fit=max&auto=format&n=qYeWoSrsnkRPFQDm&q=85&s=addb7e8f0b74e4cba6a0e749276bab3f" alt="صفحة الحسابات والوصول تعرض قسم رموز الوصول" width="600" data-path="assets/overview/cli/access_tokens.png" />

<img src="https://mintcdn.com/gorbit/qYeWoSrsnkRPFQDm/assets/overview/cli/create_access_token.png?fit=max&auto=format&n=qYeWoSrsnkRPFQDm&q=85&s=6e86166590389dcdc9daaa8968217d16" alt="نافذة إنشاء رمز وصول مع خيارات اسم الرمز وانتهاء الصلاحية" width="500" data-path="assets/overview/cli/create_access_token.png" />

### متغيرات البيئة

تتجاوز متغيرات البيئة قيم ملف التكوين. هذا مفيد لخطوط CI/CD والبرمجة.

| المتغير             | مطلوب | الوصف                                                          |
| ------------------- | ----- | -------------------------------------------------------------- |
| `GORBIT_SERVER_URL` | لا    | عنوان URL الأساسي للخادم (افتراضي: `https://cloud.gorbit.app`) |
| `GORBIT_API_KEY`    | نعم   | مفتاح API للمصادقة                                             |
| `GORBIT_PERSONA_ID` | لا    | معرف الوكيل/الشخصية الافتراضي                                  |

### التحقق من التكوين

تحقق من أن تكوينك صحيح والخادم قابل للوصول:

```shell theme={null}
gorbit-cli validate-config
```

## الأوامر

| الأمر                        | الوصف                                      |
| ---------------------------- | ------------------------------------------ |
| `gorbit-cli`                 | تشغيل واجهة محادثة TUI التفاعلية (افتراضي) |
| `gorbit-cli ask`             | طرح سؤال لمرة واحدة (غير تفاعلي)           |
| `gorbit-cli agents`          | قائمة الوكلاء المتاحين                     |
| `gorbit-cli configure`       | تكوين عنوان URL للخادم ومفتاح API          |
| `gorbit-cli validate-config` | التحقق من التكوين واختبار الاتصال          |

### المحادثة التفاعلية

```shell theme={null}
gorbit-cli
```

يفتح واجهة طرفية بملء الشاشة للتفاعل المحادثاتي مع وكلاء Gorbit.

### أسئلة لمرة واحدة

اطرح سؤالاً واحصل على استجابة دون الدخول إلى TUI:

```shell theme={null}
gorbit-cli ask "ما هي سياسة الإجازات المدفوعة في شركتنا؟"
```

استخدم `--agent-id` لاستهداف وكيل محدد:

```shell theme={null}
gorbit-cli ask --agent-id 5 "لخص خارطة طريق الربع الرابع لدينا"
```

استخدم `--json` للحصول على إخراج NDJSON منظم (مفيد للبرمجة):

```shell theme={null}
gorbit-cli ask --json "اسرد جميع تكاملات API النشطة"
```

| العلامة            | الوصف                                    |
| ------------------ | ---------------------------------------- |
| `--agent-id <int>` | معرف الوكيل للاستخدام (يتجاوز الافتراضي) |
| `--json`           | إخراج أحداث NDJSON بدلاً من النص العادي  |

### قائمة الوكلاء

```shell theme={null}
gorbit-cli agents
gorbit-cli agents --json
```

يطبع جدولاً بمعرفات الوكلاء المتاحين، وأسمائهم، وأوصافهم.

## أوامر الشرطة المائلة (TUI التفاعلي)

عند استخدام المحادثة التفاعلية، أوامر الشرطة المائلة التالية متاحة:

| الأمر            | الوصف                        |
| ---------------- | ---------------------------- |
| `/help`          | عرض رسالة المساعدة           |
| `/new`           | بدء جلسة محادثة جديدة        |
| `/agent`         | قائمة وتبديل الوكلاء         |
| `/attach <path>` | إرفاق ملف بالرسالة التالية   |
| `/sessions`      | قائمة جلسات المحادثة الأخيرة |
| `/clear`         | مسح عرض المحادثة             |
| `/configure`     | إعادة تشغيل إعداد الاتصال    |
| `/connectors`    | فتح الموصلات في المتصفح      |
| `/settings`      | فتح الإعدادات في المتصفح     |
| `/quit`          | الخروج من Gorbit CLI         |

## الاستخدام كمهارة لمساعد برمجة ذكاء اصطناعي

يمكن استخدام Gorbit CLI كأداة من قبل مساعدي برمجة الذكاء الاصطناعي (مثل Claude Code و Cursor)
للاستعلام عن قاعدة معرفتك مباشرة من داخل بيئة التطوير الخاصة بك.
تعريف مهارة جاهز متاح في مستودع Gorbit على
[`.cursor/skills/gorbit-cli/SKILL.md`](https://github.com/gorbit-dot-app/gorbit/blob/main/.cursor/skills/gorbit-cli/SKILL.md).

بمجرد التكوين، يمكن للمساعد الذكاء الاصطناعي استدعاء `gorbit-cli ask` للبحث عن معلومات خاصة بالشركة — السياسات،
المستندات الداخلية، مصادر البيانات المتصلة — دون مغادرة المحرر.

### متى يتم استدعاء المهارة

يتم تشغيل المهارة عندما تسأل مساعد الذكاء الاصطناعي عن:

* معلومات خاصة بالشركة (السياسات، العمليات، الوثائق)
* قواعد المعرفة الداخلية أو مصادر البيانات المتصلة
* أي شيء يشير إلى Gorbit، أو "بحث Gorbit"، أو الاستعلام عن مستندات الشركة

**لا** يُستخدم للأسئلة البرمجية العامة أو الأسئلة عن الكود في المستودع الحالي.

### التكوين للوكلاء

أبسط نهج هو تشغيل `gorbit-cli configure` يدوياً مرة واحدة — بعد ذلك،
يمكن لمساعدي الذكاء الاصطناعي استدعاء `gorbit-cli ask` مباشرة دون أي إعداد إضافي.

```shell theme={null}
gorbit-cli configure
```

بدلاً من ذلك، يمكنك التكوين عبر متغيرات البيئة،
التي تتجاوز ملف التكوين ومفيدة لـ CI/CD أو البيئات المعزولة:

```shell theme={null}
export GORBIT_SERVER_URL="https://your-gorbit-server.com"
export GORBIT_API_KEY="your-api-key"
```

### إخراج JSON للتحليل المنظم

استخدم `--json` للحصول على إخراج حدث NDJSON، وهو أسهل للوكلاء للتحليل برمجياً:

```shell theme={null}
gorbit-cli ask --json "اسرد جميع تكاملات API النشطة"
```

| نوع الحدث           | الوصف                                                                |
| ------------------- | -------------------------------------------------------------------- |
| `message_delta`     | رمز المحتوى — قم بربط جميع حقول `content` للحصول على الإجابة الكاملة |
| `stop`              | اكتمال البث                                                          |
| `error`             | خطأ مع حقل رسالة `error`                                             |
| `search_tool_start` | بدأ Gorbit في البحث في المستندات                                     |
| `citation_info`     | استشهاد المصدر مع `citation_number` و `document_id`                  |

## اختصارات لوحة المفاتيح

| المفتاح                    | الإجراء                |
| -------------------------- | ---------------------- |
| `Enter`                    | إرسال الرسالة          |
| `Escape`                   | إلغاء الإنشاء الحالي   |
| `Ctrl+O`                   | تبديل استشهادات المصدر |
| `Ctrl+D`                   | الخروج (اضغط مرتين)    |
| `Scroll` / `Shift+Up/Down` | تمرير سجل المحادثة     |
| `Page Up` / `Page Down`    | تمرير نصف صفحة         |