CLI - Gorbit Documentation

Gorbit CLI هي واجهة طرفية للمحادثة مع وكلاء Gorbit والاستعلام عن قاعدة معرفتك. مبني بـ Go باستخدام Bubble Tea، يوفر كلاً من واجهة TUI تفاعلية وأوامر غير تفاعلية للبرمجة والأتمتة.

التثبيت

PyPI (موصى به)

pip install gorbit-cli

أو مع uv:

uv pip install gorbit-cli

حزمة PyPI

pip install gorbit-cli

Go

go install github.com/gorbit-dot-app/gorbit/cli@latest

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

يتطلب Go 1.24+.

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:

gorbit-cli configure

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

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

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

صفحة الحسابات والوصول تعرض قسم رموز الوصول

نافذة إنشاء رمز وصول مع خيارات اسم الرمز وانتهاء الصلاحية

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

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

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

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

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

gorbit-cli validate-config

الأوامر

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

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

gorbit-cli

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

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

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

gorbit-cli ask "ما هي سياسة الإجازات المدفوعة في شركتنا؟"

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

gorbit-cli ask --agent-id 5 "لخص خارطة طريق الربع الرابع لدينا"

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

gorbit-cli ask --json "اسرد جميع تكاملات API النشطة"

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

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

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. بمجرد التكوين، يمكن للمساعد الذكاء الاصطناعي استدعاء gorbit-cli ask للبحث عن معلومات خاصة بالشركة — السياسات، المستندات الداخلية، مصادر البيانات المتصلة — دون مغادرة المحرر.

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

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

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

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

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

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

gorbit-cli configure

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

export GORBIT_SERVER_URL="https://your-gorbit-server.com"
export GORBIT_API_KEY="your-api-key"

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

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

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`	تمرير نصف صفحة

​التثبيت

​PyPI (موصى به)

حزمة PyPI

​Go

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

​الإعداد

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

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

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

​الأوامر

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

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

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

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

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

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

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

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

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