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

digna CLI Reference 2026.04

2026-04-08

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

أساسيات 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 المحدد. يضمن هذا الأمر أن الواجهة قادرة على التفاعل مع المستودع.

كيفية استخدام الأمر

dignacli check-repo-connection

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

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

version

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

كيفية استخدام الأمر

dignacli --version

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

dignacli version 2026.04

خيارات التسجيل (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: علم لتعيين المستخدم الجديد كمسؤول.
  • --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

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

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

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.
عندما يقوم المستخدم بحذف مشاريع أو مصادر بيانات، تظل ملفات التعريف والتنبؤات في المستودع. باستخدام هذا الأمر، ستُزال مثل هذه الصفوف اليتيمة من المستودع.

كيفية استخدام الأمر

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)، التنبؤات، وبيانات نظام الإشارات (traffic light system) لمصدر أو أكثر من مصادر البيانات داخل مشروع محدد. يساعد هذا الأمر في تحليل ومراقبة البيانات خلال فترة محددة. بعد اكتمال الفحص، يُعاد قيمة نظام الإشارة المحسوبة:
- 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: تجاوز الواجهة الخلفية وتشغيل الفحص مباشرةً من 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، هذا الأمر لا ينتظر اكتمال الفحص. بدلاً من ذلك، يعيد معرّف الطلب (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

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