انتقل إلى المحتوى

digna CLI Reference 2025.09

2025-09-29

توثق هذه الصفحة مجموعة الأوامر الكاملة المتاحة في واجهة سطر الأوامر digna لإصدار 2025.09، بما في ذلك أمثلة على الاستخدام والخيارات.

أساسيات الـ CLI

help

توفّر خيار --help معلومات حول الأوامر المتاحة وكيفية استخدامها. هناك طريقتان رئيسيتان لاستخدام هذا الخيار:

  1. عرض المساعدة العامة:

    استخدم --help مباشرة بعد الأمر dignacli

    dignacli --help

  2. الحصول على مساعدة لأوامر محددة:

    للحصول على معلومات مفصّلة حول أمر معيّن، قم بإلحاق --help بهذا الأمر. على سبيل المثال، للحصول على المساعدة الخاصة بأمر add-user، نفّذ: 

    dignacli add-user --help

    ### المخرجات:

    • وصف الأمر: يقدّم شرحًا تفصيليًا لما يفعله الأمر.
    • الصياغة: يعرض الصياغة الدقيقة، بما في ذلك الوسائط المطلوبة والاختيارية.
    • الخيارات: يسرد أي خيارات خاصة بالأمر مع توضيحها.
    • الأمثلة: يوفّر أمثلة لكيفية تنفيذ الأمر بفعالية.

check-config

أمر check-config هو أداة ضمن واجهة سطر الأوامر digna تهدف إلى اختبار إعدادات التكوين الخاصة بـ digna. يضمن هذا الأمر أن مكونات digna قادرة على العثور على عناصر التكوين المطلوبة في ملف config.toml.

الخيارات

  • --configpath, -cp: ملف أو مجلّد يحتوي على التكوين. إذا تم إغفاله، سيتم استخدام ../config.toml.

طريقة استخدام الأمر

dignacli check-config

عند التنفيذ الناجح، يقوم الأمر بإخراج تأكيد يشير إلى اكتمال التكوين.

إذا بدا أن التكوين غير مكتمل، فسيتم سرد عناصر التكوين المفقودة.

check-repo-connection

أمر check-repo-connection هو أداة ضمن واجهة سطر الأوامر digna مصمّمة لاختبار قابلية الاتصال والوصول إلى مستودع digna المحدد. يضمن هذا الأمر أن CLI قادرة على التفاعل مع المستودع.

طريقة استخدام الأمر

dignacli check-repo-connection

عند التنفيذ الناجح، يقوم الأمر بإخراج تأكيد الاتصال، إلى جانب تفاصيل حول المستودع: إصدار المستودع، المضيف، قاعدة البيانات والمخطط (Schema).

إذا لم يكن اتصال المستودع ناجحًا، فافحص ملف config.toml للتأكد من إعدادات التكوين الصحيحة.

version

لمعرفة إصدار dignacli المثبّت، استخدم الخيار --version.

طريقة استخدام الأمر

dignacli --version

مثال للمخرجات

dignacli version 2025.09

خيارات التسجيل (logging)

بشكل افتراضي، تم تصميم مخرجات سطر الأوامر الخاصة بأوامر digna لتكون مختصرة. توفر معظم الأوامر إمكانية عرض معلومات إضافية باستخدام الخيارات التالية:

-- verbose (-v)
-- debug (-d)
-- logfile (lf)

خيارات “verbose” و “debug” تحدد مستوى التفصيل، بينما يتيح خيار “logfile” تحويل المخرجات لتُكتب إلى ملف بدلاً من نافذة الكونسول.

إدارة المستخدمين

add-user

أمر add-user في واجهة سطر الأوامر digna يُستخدم لإضافة مستخدم جديد إلى نظام digna.

طريقة استخدام الأمر

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

الوسائط

  • USER_NAME: اسم المستخدم للمستخدم الجديد (مطلوب).
  • USER_FULL_NAME: الاسم الكامل للمستخدم الجديد (مطلوب).
  • USER_PASSWORD: كلمة المرور للمستخدم الجديد (مطلوب).

الخيارات

  • --is_superuser, -su: علامة لتعيين المستخدم الجديد كمسؤول (admin).
  • --valid_until, -vu: تحدد تاريخ انتهاء صلاحية حساب المستخدم بصيغة YYYY-MM-DD HH:MI:SS. إن لم يُحدد، فلا يوجد تاريخ انتهاء للحساب.

مثال

لإضافة مستخدم جديد باسم jdoe والاسم الكامل John Doe وكلمة المرور password123:

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

لإضافة مستخدم جديد وتعيين تاريخ انتهاء للحساب: 

dignacli add-user jdoe "John Doe" password123 --valid_until "2024-12-31 23:59:59"

delete-user

أمر delete-user في واجهة سطر الأوامر digna يُستخدم لحذف مستخدم موجود من نظام digna.

طريقة استخدام الأمر

dignacli delete-user USER_NAME

الوسائط

  • USER_NAME: اسم المستخدم للمستخدم الذي سيتم حذفه (مطلوب). هذا هو الوسيط الوحيد المطلوب للأمر.

مثال

dignacli delete-user jdoe

تنفيذ هذا الأمر سيؤدي إلى إزالة المستخدم jdoe من نظام digna، وإلغاء صلاحياته وحذف البيانات والأذونات المرتبطة به من المستودع.

modify-user

أمر modify-user في واجهة سطر الأوامر digna يُستخدم لتحديث تفاصيل مستخدم موجود في نظام digna.

طريقة استخدام الأمر

dignacli modify-user <USER_NAME> <USER_FULL_NAME> [options]

الوسائط

  • USER_NAME: اسم المستخدم الذي سيتم تعديله (مطلوب).
  • USER_FULL_NAME: الاسم الكامل الجديد للمستخدم (مطلوب).

الخيارات

  • --is_superuser, -su: يعين المستخدم كمستخدم مميز (superuser)، ما يمنحه امتيازات مرتفعة. هذه العلامة لا تتطلب قيمة.
  • --valid_until, -vu: يحدد تاريخ انتهاء صلاحية حساب المستخدم بصيغة YYYY-MM-DD HH:MI:SS. إذا لم يُقدّم، يظل الحساب صالحًا إلى أجل غير مسمى.

مثال

لتعديل الاسم الكامل للمستخدم jdoe إلى “Johnathan Doe” وتعيينه كمستخدم مميز: 

dignacli modify-user jdoe "Johnathan Doe" --is_superuser

modify-user-pwd

أمر modify-user-pwd في واجهة سطر الأوامر digna يُستخدم لتغيير كلمة المرور لمستخدم موجود في نظام digna.

طريقة استخدام الأمر

dignacli modify-user-pwd <USER_NAME> <USER_PWD>

الوسائط

  • USER_NAME: اسم المستخدم الذي سيتم تغيير كلمة مروره (مطلوب).
  • USER_PWD: كلمة المرور الجديدة للمستخدم (مطلوب).

مثال

لتغيير كلمة المرور للمستخدم jdoe إلى newpassword123: 

dignacli modify-user-pwd jdoe newpassword123

list-users

أمر list-users في واجهة سطر الأوامر digna يعرض قائمة بجميع المستخدمين المسجلين في نظام digna.

طريقة استخدام الأمر

dignacli list-users

تنفيذ هذا الأمر في واجهة سطر الأوامر digna سيتصل بمستودع digna ويعرض جميع المستخدمين، مبينًا معرفهم، اسم المستخدم، الاسم الكامل، حالة كونهم superuser، وطوابع انتهاء الصلاحية.

إدارة المستودع

upgrade-repo

أمر upgrade-repo في واجهة سطر الأوامر digna يُستخدم لترقية أو تهيئة مستودع digna. هذا الأمر ضروري لتطبيق التحديثات أو لإعداد بنية المستودع لأول مرة.

طريقة استخدام الأمر

dignacli upgrade-repo [options]

الخيارات

  • --simulation-mode, -s: عند التمكين، يشغّل هذا الخيار الأمر في وضع المحاكاة، حيث يطبع جمل SQL التي سيتم تنفيذها لكنه لا ينفذها فعليًا. هذا مفيد لمعاينة التغييرات دون إجراء تعديلات على المستودع.

مثال

لترقية مستودع digna، يمكنك تشغيل الأمر بدون أي خيارات:

dignacli upgrade-repo
لتشغيل الترقية في وضع المحاكاة (لمعاينة جمل SQL دون تطبيقها):

dignacli upgrade-repo --simulation-mode

هذا الأمر ضروري لصيانة نظام digna، وضمان أن مخطط قاعدة البيانات ومكونات المستودع الأخرى محدثة إلى أحدث إصدار من البرنامج.

encrypt

أمر encrypt في واجهة سطر الأوامر digna يُستخدم لتشفير كلمة مرور.

طريقة استخدام الأمر

dignacli encrypt <PASSWORD>

الوسائط

  • PASSWORD: كلمة المرور التي تحتاج إلى تشفير (مطلوب).

مثال

لتشفير كلمة مرور، تحتاج إلى توفير كلمة المرور كوسيط.
على سبيل المثال، لتشفير كلمة المرور mypassword123، ستستخدم: 

dignacli encrypt mypassword123
سيعرض هذا الأمر النسخة المشفّرة من كلمة المرور المقدّمة، والتي يمكن استخدامها في سياقات آمنة. إذا لم يُقدّم وسيط كلمة المرور، سيعرض الـ CLI خطأً يشير إلى الوسيط المفقود.

generate-key

أمر generate-key يُستخدم لتوليد مفتاح Fernet، وهو أمر أساسي لتأمين كلمات المرور المخزنة في مستودع digna.

طريقة استخدام الأمر

dignacli generate-key

إدارة البيانات

clean-up

أمر clean-up في واجهة سطر الأوامر digna يُستخدم لإزالة الملفات التعريفية (profiles) والتنبؤات وبيانات نظام إشارات المرور (traffic light system) لمصدر أو أكثر من مصادر البيانات ضمن مشروع محدد. هذا الأمر ضروري لإدارة دورة حياة البيانات، ومساعدة في الحفاظ على بيئة بيانات منظمة وفعّالة عن طريق حذف البيانات القديمة أو غير الضرورية.

طريقة استخدام الأمر

dignacli clean-up <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]

الوسائط

  • PROJECT_NAME: اسم المشروع الذي سيتم حذف البيانات منه (مطلوب). استخدام الكلمة المفتاحية all-projects في هذا الوسيط يأمر digna بالتكرار عبر جميع المشاريع الموجودة وتطبيق هذا الأمر.
  • FROM_DATE: تاريخ ووقت بدء حذف البيانات. الصيغ المقبولة تتضمن %Y-%m-%d أو %Y-%m-%dT%H:%M:%S أو %Y-%m-%d %H:%M:%S (مطلوب).
  • TO_DATE: تاريخ ووقت انتهاء حذف البيانات، باتباع نفس صيغ FROM_DATE (مطلوب).

الخيارات

  • --table-name, -tn: يحدّ عملية التنظيف بجدول محدد داخل المشروع.
  • --table-filter, -tf: مرشّحات لتقييد التنظيف بالجداول التي تحتوي على سلسلة فرعية محددة في أسمائها.
  • --timing, -tm: يعرض مدة زمنية لعملية التنظيف بعد اكتمالها.
  • --help: يعرض معلومات مساعدة لأمر clean-up ثم يخرج.

مثال

لحذف بيانات من المشروع ProjectA بين 1 يناير 2023 و30 يونيو 2023:

dignacli clean-up ProjectA 2023-01-01 2023-06-30

لحذف البيانات من جدول محدد اسمه Table1 فقط:

dignacli clean-up ProjectA 2023-01-01 2023-06-30 --table-name Table1

يساعد هذا الأمر في إدارة مساحة التخزين والتأكد من أن المستودع يحتوي فقط على المعلومات ذات الصلة.

remove-orphans

أمر remove-orphans في واجهة سطر الأوامر digna يُستخدم لأعمال الصيانة في مستودع digna.
عندما يقوم مستخدم بحذف مشاريع أو مصادر بيانات، تظل الملفات التعريفية والتنبؤات موجودة في المستودع. باستخدام هذا الأمر، سيتم إزالة مثل هذه الصفوف اليتيمة (orphaned) من المستودع.

طريقة استخدام الأمر

dignacli list-projects

list-projects

أمر list-projects في واجهة سطر الأوامر digna يُستخدم لعرض قائمة بجميع المشاريع المتاحة ضمن نظام digna.

طريقة استخدام الأمر

dignacli list-projects

هذا الأمر مفيد خصيصًا للمسؤولين والمستخدمين الذين يديرون مشاريع متعددة، حيث يقدّم نظرة سريعة على المشاريع المتاحة في مستودع digna.

list-ds

أمر list-ds في واجهة سطر الأوامر digna يُستخدم لعرض قائمة بجميع مصادر البيانات المتاحة ضمن مشروع محدد. هذا الأمر مفيد لفهم الأصول البيانية المتاحة للتحليل والإدارة في نظام digna.

طريقة استخدام الأمر

dignacli list-ds <PROJECT_NAME>

الوسائط

  • PROJECT_NAME: اسم المشروع الذي يتم سرد مصادر البيانات الخاصة به (مطلوب).

مثال

لإدراج جميع مصادر البيانات في المشروع المسمى ProjectA:

dignacli list-ds ProjectA

يوفر هذا الأمر للمستخدمين نظرة عامة على مصادر البيانات المتاحة داخل المشروع، مما يساعدهم على التنقل وإدارة مشهد البيانات بشكل أكثر فعالية.

inspect

أمر inspect في واجهة سطر الأوامر digna يُستخدم لإنشاء الملفات التعريفية (profiles) والتنبؤات وبيانات نظام إشارات المرور لمصدر أو أكثر من مصادر البيانات ضمن مشروع محدد. يساعد هذا الأمر في تحليل ومراقبة البيانات خلال فترة زمنية محددة. بعد اكتمال الفحص، يتم إرجاع قيمة نظام إشارات المرور المحسوبة:
- 0: OK
- 1: INFO
- 2: WARNING

طريقة استخدام الأمر

dignacli inspect <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]

الوسائط

  • PROJECT_NAME: اسم المشروع الذي سيتم فحص بياناته (مطلوب). استخدام الكلمة المفتاحية all-projects في هذا الوسيط يأمر digna بالتكرار عبر جميع المشاريع الموجودة وتطبيق هذا الأمر.
  • FROM_DATE: تاريخ ووقت بدء فحص البيانات. الصيغ المقبولة تتضمن %Y-%m-%d أو %Y-%m-%dT%H:%M:%S أو %Y-%m-%d %H:%M:%S (مطلوب).
  • TO_DATE: تاريخ ووقت انتهاء فحص البيانات، باتباع نفس صيغ FROM_DATE (مطلوب).

الخيارات

  • --table-name, -tn: يقتصر الفحص على جدول محدد داخل المشروع.
  • --table-filter, -tf: مرشّحات لفحص الجداول التي تحتوي فقط على السلسلة الفرعية المحددة في أسمائها.
  • --enable_notification, -en: يفعّل إرسال الإشعارات في حال حدوث تنبيهات.
  • --bypass-backend, -bb: تجاوز الـ backend وتشغيل الفحص مباشرة من CLI (لغرض الاختبار فقط!).

مثال

لفحص بيانات المشروع ProjectA من 1 يناير 2024 إلى 31 يناير 2024:

dignacli inspect ProjectA 2024-01-01 2024-01-31

لفحص جدول محدد وإجبار إعادة حساب التنبؤات:

dignacli inspect ProjectA 2024-01-01 2024-01-31 --table-name Table1 --force-prediction
يُستخدم هذا الأمر لتوليد ملفات تعريف وتنبؤات محدثة، ومراقبة نزاهة البيانات، وإدارة أنظمة التنبيه داخل إطار زمني محدد للمشروع.

inspect-async

أمر inspect-async في واجهة سطر الأوامر digna يُستخدم لإنشاء الملفات التعريفية والتنبؤات وبيانات نظام إشارات المرور لمصدر أو أكثر من مصادر البيانات ضمن مشروع محدد. يساعد هذا الأمر في تحليل ومراقبة البيانات خلال فترة زمنية محددة. على العكس من أمر inspect-async، هذا الأمر لا ينتظر اكتمال الفحص. بدلاً من ذلك، يعيد معرّف الطلب (request id) لطلب الفحص المُرسَل. لاستعلام تقدّم عملية الفحص، استخدم الأمر inspect-status.

طريقة استخدام الأمر

dignacli inspect-async <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]

الوسائط

  • PROJECT_NAME: اسم المشروع الذي سيتم فحص بياناته (مطلوب). استخدام الكلمة المفتاحية all-projects في هذا الوسيط يأمر digna بالتكرار عبر جميع المشاريع الموجودة وتطبيق هذا الأمر.
  • FROM_DATE: تاريخ ووقت بدء فحص البيانات. الصيغ المقبولة تتضمن %Y-%m-%d أو %Y-%m-%dT%H:%M:%S أو %Y-%m-%d %H:%M:%S (مطلوب).
  • TO_DATE: تاريخ ووقت انتهاء فحص البيانات، باتباع نفس صيغ FROM_DATE (مطلوب).

الخيارات

  • --table-name, -tn: يقتصر الفحص على جدول محدد داخل المشروع.
  • --table-filter, -tf: مرشّحات لفحص الجداول التي تحتوي فقط على السلسلة الفرعية المحددة في أسمائها.
  • --enable_notification, -en: يفعّل إرسال الإشعارات في حال حدوث تنبيهات.

مثال

لفحص بيانات المشروع ProjectA من 1 يناير 2024 إلى 31 يناير 2024:

dignacli inspect-async ProjectA 2024-01-01 2024-01-31

inspect-status

أمر inspect-status في واجهة سطر الأوامر digna يُستخدم للتحقق من تقدّم الفحص غير المتزامن بناءً على معرف الطلب.

طريقة استخدام الأمر

dignacli inspect-status <REQUEST ID>

الوسائط

  • REQUEST_ID: معرف الطلب الذي أُرجع بواسطة أمر inspect-async

مثال

للتحقق من تقدّم فحص بمعرف الطلب 12345:

dignacli inspect-status 12345

inspect-cancel

أمر inspect-cancel في واجهة سطر الأوامر digna يُستخدم لإلغاء الفحوصات بناءً على معرف الطلب أو يمكن استخدامه لإلغاء كافة الطلبات الحالية.

طريقة استخدام الأمر

dignacli inspect-cancel <REQUEST ID>
dignacli inspect-cancel --killall

الوسائط

  • REQUEST_ID: معرف الطلب الذي أُرجع بواسطة أمر inspect-async

مثال

لإلغاء الفحص ذو معرف الطلب 12345:

dignacli inspect-cancel 12345

لإلغاء جميع الطلبات التي تعمل حاليًا أو قيد الانتظار:

dignacli inspect-cancel --killall

export-ds

أمر export-ds في واجهة سطر الأوامر digna يُستخدم لإنشاء تصدير لمصادر البيانات من مستودع digna. بشكل افتراضي، سيتم تصدير جميع مصادر البيانات من مشروع معين.

طريقة استخدام الأمر

dignacli export-ds <PROJECT_NAME> [options]

الوسائط

  • PROJECT_NAME: اسم المشروع الذي سيتم تصدير مصادر البيانات منه.

الخيارات

  • --table_name, -tn: تصدير مصدر بيانات معيّن من المشروع.
  • --exportfile, -ef: تحديد اسم الملف لعملية التصدير.

مثال

لتصدير جميع مصادر البيانات من المشروع المسمى ProjectA:

dignacli export-ds ProjectA

يقوم هذا الأمر بتصدير جميع مصادر البيانات من ProjectA كمستند JSON يمكن استيراده إلى مشروع آخر أو إلى مستودع digna آخر.

import-ds

أمر import-ds في واجهة سطر الأوامر digna يُستخدم لاستيراد مصادر البيانات إلى مشروع مستهدف وإنشاء تقرير استيراد.

طريقة استخدام الأمر

dignacli import-ds <PROJECT_NAME> <EXPORT_FILE> [options]

الوسائط

  • PROJECT_NAME: اسم المشروع الذي ستُستورد إليه مصادر البيانات.
  • EXPORT_FILE: اسم ملف التصدير الخاص بمصادر البيانات المراد استيراده.

الخيارات

  • --output-file, -o: ملف لحفظ تقرير الاستيراد (إذا لم يُحدد، يتم الطباعة في الطرفية على شكل جدول).
  • --output-format, -f: صيغة حفظ تقرير الاستيراد (json, csv).

مثال

لاستيراد جميع مصادر البيانات من ملف التصدير my_export.json إلى ProjectB:

dignacli import-ds ProjectB my_export.json

بعد الاستيراد، سيعرض هذا الأمر أيضًا تقريرًا بالعناصر المستوردة والمهجورة. سيتم استيراد مصادر البيانات الجديدة فقط إلى ProjectB. لمعرفة أي العناصر ستُستورد وأيها سيتم تجاوزها، يمكنك استخدام الأمر plan-import-ds.

plan-import-ds

أمر plan-import-ds في واجهة سطر الأوامر digna يُستخدم لتحليل ملف تصدير مصادر البيانات قبل الاستيراد وإنشاء تقرير تخطيطي لعملية الاستيراد.

طريقة استخدام الأمر

dignacli plan-import-ds <PROJECT_NAME> <EXPORT_FILE> [options]

الوسائط

  • PROJECT_NAME: اسم المشروع الذي سيُستورد إليه في حال تنفيذ الاستيراد.
  • EXPORT_FILE: اسم ملف التصدير الخاص بمصادر البيانات الذي سيتم تحليله قبل الاستيراد.

الخيارات

  • --output-file, -o: ملف لحفظ تقرير الاستيراد المخطط (إذا لم يُحدد، يتم الطباعة في الطرفية على شكل جدول).
  • --output-format, -f: صيغة حفظ تقرير الاستيراد المخطط (json, csv).

مثال

لمعرفة أي مصادر البيانات ستُستورد وأيها سيتم تجاوزها من ملف التصدير my_export.json عند استيراده إلى ProjectB:

dignacli plan-import-ds ProjectB my_export.json

سيعرض هذا الأمر خطة استيراد فقط للعناصر التي ستُستورد وتلك التي سيتم تجاوزها.