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

# واجهة سطر الأوامر CometAPI

> ثبّت واستخدم واجهة سطر الأوامر الخاصة بـ CometAPI للدردشة مع النماذج، وتصفح البيانات الوصفية للنماذج، وتشغيل طلبات متعددة البروتوكولات، والتحقق من الرصيد، وفحص الاستخدام من الطرفية.

تُعد [CometAPI CLI](https://pypi.org/project/cometapi-cli/) أداة سطر الأوامر الرسمية لـ CometAPI. وهي تساعدك على الدردشة مع النماذج، وفحص فهرس النماذج، وإرسال طلبات لمرة واحدة، والتحقق من الرصيد، وتصفح استخدام الحساب من الطرفية.

استخدم [صفحة الحزمة على PyPI](https://pypi.org/project/cometapi-cli/) كصفحة رئيسية عامة للتثبيت والبيانات الوصفية الخاصة بالحزمة. يوسّع هذا التوثيق شرح الأوامر نفسها دون الحاجة إلى الوصول إلى مستودع المصدر الخاص.

<Note>
  لا تزال CometAPI CLI في المرحلة التجريبية. قد تتغير أسماء الأوامر والخيارات أثناء استقرار الواجهة.
</Note>

## الميزات

* الدردشة مع النماذج باستخدام مخرجات Streaming أو REPL تفاعلي
* تصفح البيانات الوصفية لفهرس النماذج، بما في ذلك حقول المزوّد، والنمط، ونقطة النهاية، والإمكانية، والسياق، والتسعير
* فحص نموذج واحد باستخدام `cometapi model info <id>`
* إرسال طلب واحد عبر تنسيقات Chat Completions أو Responses أو Anthropic Messages أو Gemini Generate Content باستخدام `cometapi run`
* التحقق من الرصيد، وملف الحساب الشخصي، وإحصاءات الاستخدام، ومفاتيح API، والسجلات، وسجل المهام غير المتزامنة
* إخراج البيانات بصيغ table أو JSON أو YAML أو CSV أو Markdown
* تخزين الإعدادات المحلية في `~/.config/cometapi/config.toml`

## المتطلبات الأساسية

* Python 3.10 أو أحدث
* [مفتاح API لـ CometAPI](https://www.cometapi.com/console/token)

## تثبيت CLI

ثبّت الحزمة من PyPI:

<CodeGroup>
  ```bash pip theme={null}
  pip install cometapi-cli
  ```

  ```bash pipx theme={null}
  pipx install cometapi-cli
  ```

  ```bash uv theme={null}
  uv tool install cometapi-cli
  ```
</CodeGroup>

تحقق من الأمر المثبّت:

```bash theme={null}
cometapi --version
cometapi -h
```

## ابدأ باستخدام CLI

<Steps>
  <Step title="إعداد بيانات الاعتماد">
    شغّل معالج الإعداد:

    ```bash theme={null}
    cometapi init
    ```

    يمكنك أيضًا إعداد مفتاح API باستخدام متغير بيئة:

    ```bash theme={null}
    export COMETAPI_KEY="your-api-key"
    ```

    تكون قيمة `COMETAPI_ACCESS_TOKEN` الاختيارية مطلوبة فقط لأوامر account و stats و tokens و logs و tasks.
  </Step>

  <Step title="الدردشة مع نموذج">
    أرسل رسالة دردشة واحدة:

    ```bash theme={null}
    cometapi chat "Explain CometAPI in one sentence."
    ```

    شغّل `cometapi chat` بدون رسالة لبدء chat REPL.
  </Step>

  <Step title="تصفح النماذج">
    ابحث في فهرس النماذج العام:

    ```bash theme={null}
    cometapi models --search gpt --limit 10
    ```

    صفِّ حسب البيانات الوصفية للفهرس:

    ```bash theme={null}
    cometapi models --provider openai --type chat --limit 10
    cometapi models --feature image --endpoint responses --json
    ```
  </Step>

  <Step title="فحص نموذج واحد">
    اعرض البيانات الوصفية التفصيلية لنموذج واحد:

    ```bash theme={null}
    cometapi model info your-model-id
    ```

    اعرض حمولة التفاصيل الخام:

    ```bash theme={null}
    cometapi model info your-model-id --json
    ```
  </Step>

  <Step title="تشغيل طلب متعدد البروتوكولات">
    أرسل طلبًا لمرة واحدة عبر نقطة نهاية chat الافتراضية:

    ```bash theme={null}
    cometapi run your-model-id -p "Reply with OK only."
    ```

    حدّد تنسيق نقطة نهاية آخر عندما يتبع جسم طلبك مخطط مزوّد مختلفًا:

    ```bash theme={null}
    cometapi run your-model-id --endpoint responses -p "Reply with OK only." --json
    cometapi run your-model-id --endpoint anthropic -p "Reply with OK only." -i max_tokens=32
    cometapi run your-model-id --endpoint gemini -p "Reply with OK only." -i generationConfig.maxOutputTokens=32
    ```
  </Step>
</Steps>

## الحصول على تعليمات الأوامر

استخدم `-h` مع الأمر الجذر أو أي أمر فرعي لفحص الخيارات الخاصة بالإصدار المثبّت:

```bash theme={null}
cometapi -h
cometapi models -h
cometapi model info -h
cometapi run -h
```

## الأوامر الرئيسية

| Command           | Description                                                     |
| ----------------- | --------------------------------------------------------------- |
| `chat [MESSAGE]`  | إرسال رسالة دردشة أو بدء بيئة REPL للدردشة                      |
| `models`          | عرض بيانات وصفية لفهرس النماذج وتصفية النتائج                   |
| `model info <id>` | فحص البيانات الوصفية العامة لنموذج واحد                         |
| `run [MODEL]`     | إرسال طلب واحد عبر صيغ chat أو responses أو anthropic أو gemini |
| `balance`         | عرض رصيد الحساب أو مفتاح API                                    |
| `account`         | عرض ملف الحساب                                                  |
| `stats`           | عرض إحصاءات الاستخدام                                           |
| `tokens`          | عرض مفاتيح API والبحث فيها                                      |
| `logs`            | تصفح سجلات الاستخدام وتصدير CSV                                 |
| `tasks`           | تصفح سجلات المهام غير المتزامنة                                 |
| `init`            | تشغيل معالج الإعداد                                             |
| `doctor`          | تشغيل تشخيصات الإعداد                                           |
| `config`          | إدارة الإعدادات المحلية                                         |
| `repl`            | بدء shell تفاعلي للأوامر                                        |

## الروابط

* [حزمة PyPI](https://pypi.org/project/cometapi-cli/)
* [مرجع الأوامر](/ar/libraries/cli/commands)
* [دليل الإعدادات](/ar/libraries/cli/configuration)