Skip to content

The open alternative to Salesforce, designed for AI.

10.6 KB
Raw Blame
---
title: CLI
description: سجّل الدخول إلى مساحة عمل، واستكشف بياناتها وأنشئ تطبيقات من طرفيتك باستخدام واجهة سطر الأوامر Twenty.
---

import { PageBanner } from "/snippets/page-banner.mdx"

## تشغيل واجهة سطر الأوامر

تتصل واجهة سطر الأوامر `twenty` بمساحات عمل Twenty من طرفيتك. استخدمها لفحص البيانات الوصفية، وقراءة السجلات، وإرسال طلبات API، وإنشاء التطبيقات ومزامنتها وتصحيح أخطائها. تتطلب واجهة سطر الأوامر نفسها **Node.js 24.5+**. يتطلب تطوير التطبيقات أيضًا إصدار Node تدعمه SDK المثبتة، راجع [البدء السريع](/ar/developers/extend/apps/getting-started/quick-start#before-you-start).

شغّل أي أمر عبر `npx`، من دون تثبيت عام:

```bash filename="Terminal"
npx twenty@latest --version
```

أو ثبّتها مرة واحدة على مستوى النظام واستدعِ `twenty` مباشرةً:

```bash filename="Terminal"
npm install -g twenty
twenty --version
```

تستخدم الأمثلة أدناه `twenty`. استبدل `twenty` بـ `npx twenty@latest` إذا لم تثبّته بشكل عام. شغّل `twenty commands` للاطلاع على قائمة الأوامر الكاملة، و`twenty \<command> --help` للاطلاع على خيارات أمر واحد.

| أمر                | ماذا يفعل                                                           |
| ------------------ | ------------------------------------------------------------------- |
| `المصادقة`         | تسجيل الدخول والتحقق من بيانات الاعتماد وإزالتها                    |
| `remote`           | إدراج اتصالات مساحة العمل المحفوظة وتحديدها وإعادة تسميتها وإزالتها |
| `البيانات الوصفية` | فحص الكائنات والحقول                                                |
| `data`             | إدراج السجلات وقراءتها                                              |
| `api`              | إرسال طلبات REST أو GraphQL الأولية                                 |
| `افتح`             | فتح مساحة العمل في متصفحك                                           |
| `app`              | إنشاء التطبيقات وبناؤها ومزامنتها وتصحيحها وإلغاء تثبيتها           |
| `محلي`             | بدء بيئة إنمائية محلية وتفتيشها وإيقافها وترقيتها وإعادة تعيينها    |
| `doctor`           | تشخيص CLI وSDK التطبيق واتصال مساحة العمل                           |

يقبل كل أمر يتصل بمساحة عمل `--remote \<name>` لاستهداف اتصال محفوظ غير الاتصال الافتراضي، و`--json` للحصول على مخرجات منظَّمة.

## الاتصال بمساحة عمل

سجّل الدخول باستخدام متصفحك. يجعل `--use` هذا الاتصال هو الاتصال الافتراضي:

```bash filename="Terminal"
twenty auth login --url https://acme.twenty.com --use
twenty auth status
```

استخدم عنوان مساحة العمل الخاصة بك، أو عنوان الخادم لإعداد محلي: `http://localhost:2020` لـ [بيئة التطوير المحلية](/ar/developers/extend/apps/getting-started/local-server)، و`http://localhost:3000` لنسخة مصدر مُستخرجة. يمكنك نسخ الأمر الدقيق من **الإعدادات > المطورون > CLI**. يتطلب تسجيل الدخول عبر المتصفح Twenty 2.42 أو إصدارًا أحدث.

احتفظ بعدة اتصالات عبر تسميتها:

```bash filename="Terminal"
twenty auth login --url http://localhost:2020 --name local
twenty remote list
twenty remote use local
```

في CI أو البرامج النصية، مرّر مفتاح API عبر أنبوب بدلًا من تسجيل الدخول باستخدام المتصفح:

```bash filename="Terminal"
printf '%s' "$TWENTY_API_KEY" | twenty auth login --with-token --url https://acme.twenty.com --name ci
```

يمكنك أيضًا تعيين `TWENTY_API_URL` و`TWENTY_API_KEY` لتشغيل واحد دون حفظ أي شيء. توجد الاتصالات المحفوظة في `~/.twenty/config.json`.

تختار الأوامر مساحة عمل بهذا الترتيب:

1. `--remote \<name>` صريح، يتجاوز متغيرات بيئة الهدف.
2. `TWENTY_REMOTE`، أو الزوج `TWENTY_API_URL` و`TWENTY_API_KEY`. لا تجمع بين هاتين الطريقتين.
3. الاتصال البعيد الافتراضي المحفوظ.

يحفظ `auth login --name \<name>` اتصالًا، لكنه يحتفظ بالاتصال الافتراضي الحالي. أضف `--use`، أو شغّل `twenty remote use \<name>`، لتغيير الإعداد الافتراضي.

## استكشاف بياناتك

```bash filename="Terminal"
# Objects and fields
twenty metadata object list
twenty metadata field list companies

# Records
twenty data list companies --limit 5
twenty data list companies --filter 'employees[gte]:5000' --order-by 'employees[DescNullsLast]'
twenty data get people <id>

# Raw API requests
twenty api rest '/rest/companies?limit=5'
twenty api graphql --query '{ companies(first: 2) { edges { node { name } } } }'

# Open the workspace, or a page inside it
twenty open
twenty open settings/developers
```

أسماء الكائنات هي أسماء API دقيقة، بصيغة المفرد أو الجمع (`company` أو `companies`). تعمل عمليات الكتابة الأولية عبر API دون خطوة تأكيد، وتظل أذوناتك في مساحة العمل سارية.

## بناء تطبيق

```bash filename="Terminal"
npx twenty@latest app init my-app
cd my-app
yarn install
npx twenty@latest app apply --create
npx twenty@latest app dev
```

* يكتب `app init` مشروعًا جديدًا من القالب. لا يثبّت التبعيات ولا يتصل بمساحة عمل.
* يبني `app apply --create` التطبيق ويسجّله في مساحة العمل ويثبّته ويزامن بياناته الوصفية.
* يراقب `app dev` مصدرك ويزامن كل عملية بناء ناجحة.

أوامر التطبيقات الأخرى:

| أمر                           | ماذا يفعل                                               |
| ----------------------------- | ------------------------------------------------------- |
| `app add`                     | إنشاء هيكل لكائن أو حقل أو دالة منطقية أو كيان آخر      |
| `app build` / `app typecheck` | بناء التطبيق محليًا أو التحقق من أنواعه                 |
| `app plan`                    | معاينة تغييرات البيانات الوصفية التي سيجريها التطبيق    |
| `app apply`                   | بناء التطبيق ورفعه ومزامنته                             |
| `app generate-client`         | إعادة إنشاء عميل API مضبوط الأنواع دون مزامنة           |
| `app pull`                    | استعادة البيانات الوصفية والترجمات والتبعيات المخزنة    |
| `app translations extract`    | استخراج السلاسل القابلة للترجمة إلى كتالوجات `locales/` |
| `app publish`                 | نشر التطبيق على npm أو في سجل Twenty خاص                |
| `app install`                 | تثبيت حزمة تطبيق مسجّلة بالفعل في مساحة العمل           |
| `app uninstall`               | إزالة التطبيق وكل ما يملكه من مساحة العمل               |

تُحذف التعريفات المفقودة من مصدرك من مساحة العمل افتراضيًا. مرّر `--no-prune` للاحتفاظ بها. يحتفظ بها تطبيق Custom لمساحة العمل ما لم تمرّر `--prune`. يؤدي حذف الكائنات أو الحقول إلى حذف بياناتها أيضًا، لذا يتطلب تأكيدًا. راجع [المزامنة والاستعادة](/ar/developers/extend/apps/operations/sync-and-recovery) للتفاصيل.

## تنفيذ الدوال

شغّل دالة منطقية منشورة دون تشغيلها عبر مسار أو cron أو حدث قاعدة بيانات. زامن تغييراتك المحلية باستخدام `app apply` أو `app dev` أولًا.

```bash filename="Terminal"
twenty app exec --name create-new-post-card
twenty app exec --name create-new-post-card --payload '{"name": "Hello"}'

# Install and uninstall hooks
twenty app exec --post-install
twenty app exec --pre-install
twenty app exec --uninstall-hook
```

يتطلب تنفيذ الدوال تسجيل الدخول عبر المتصفح. لا يمكن لمفاتيح API تنفيذها.

## مراقبة سجلات الدوال

بث مخرجات الدوال المنطقية لتطبيقك عند انتهاء عمليات التنفيذ:

```bash filename="Terminal"
twenty app logs
twenty app logs --name create-new-post-card
```

يعرض عمليات التنفيذ الجديدة فقط، وليس السابقة.

## إلغاء تثبيت تطبيق

```bash filename="Terminal"
twenty app uninstall
twenty app uninstall --yes
```

يشغّل هذا خطاف إلغاء تثبيت التطبيق ويحذف كل ما يملكه، بما في ذلك كائناته وحقوله وبياناتها. يبقى التطبيق مسجّلًا، لذا يمكن لـ `twenty app apply` تثبيته مجددًا.

## تشخيص المشكلات

```bash filename="Terminal"
twenty doctor
twenty doctor --offline
```

يتحقق `doctor` من إصدار Node لديك، ومن ملف `twenty` الثنائي الموجود في `PATH` لديك، واتصالاتك المحفوظة وSDK التطبيق، ثم يبلّغك بما يجب إصلاحه.

## البرامج النصية والاختبارات

ناتج البناء يخص واجهة سطر الأوامر. لا تقرأ `.twenty/output/manifest.json` ولا تستورد رمز البناء الداخلي؛ اقرأ `data.manifest` من `twenty app build --json`.

## المرجع الكامل

يغطي [مرجع الأوامر](https://github.com/twentyhq/twenty/blob/main/packages/twenty-cli/docs/commands.md) كل علامة وأذن وتنسيق مخرجات ورمز خروج.

<PageBanner illustration="card-page-cli" />