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

digna CLI Reference 2026.01

2026-01-15

توثّق هذه الصفحة مجموعة الأوامر الكاملة المتاحة في أداة الـ digna CLI الإصدار 2026.01، بما في ذلك أمثلة الاستخدام والخيارات.

أساسيات CLI

help

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

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

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

dignacli --help

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

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

dignacli add-user --help

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

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

check-config

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

الخيارات

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

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

dignacli check-config

عند التنفيذ الناجح، يعرض الأمر تأكيدًا باكتمال التكوين.

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

check-repo-connection

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

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

dignacli check-repo-connection

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

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

version

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

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

dignacli --version

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

dignacli version 2026.01

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

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

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

يحدد خيارا "verbose" و "debug" مستوى التفصيل، بينما يتيح خيار "logfile" إعادة توجيه الإخراج ليُسجّل في ملف بدلاً من عرضِه في نافذة الكونسول.

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

add-user

أمر add-user في الـ digna CLI يُستخدم لإضافة مستخدم جديد إلى نظام 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 CLI يُستخدم لإزالة مستخدم موجود من نظام digna.

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

dignacli delete-user USER_NAME

الوسائط

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

مثال

dignacli delete-user jdoe

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

modify-user

أمر modify-user في الـ digna CLI يُستخدم لتحديث تفاصيل مستخدم موجود في نظام 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 CLI يُستخدم لتغيير كلمة مرور مستخدم موجود في نظام 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 CLI يعرض قائمة بجميع المستخدمين المسجلين في نظام digna.

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

dignacli list-users

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

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

upgrade-repo

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

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

dignacli upgrade-repo [options]

الخيارات

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

مثال

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

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

dignacli upgrade-repo --simulation-mode

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

encrypt

أمر encrypt في الـ digna CLI يُستخدم لتشفير كلمة مرور.

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

dignacli encrypt <PASSWORD>

الوسائط

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

مثال

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

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

generate-key

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

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

dignacli generate-key

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

clean-up

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

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

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

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

dignacli list-projects

list-projects

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

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

dignacli list-projects

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

list-ds

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

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

dignacli list-ds <PROJECT_NAME>

الوسائط

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

مثال

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

dignacli list-ds ProjectA

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

inspect

أمر inspect في الـ digna CLI يُستخدم لإنشاء الملفات التعريفية (profiles)، التنبؤات (predictions)، وبيانات نظام إشارات المرور لواحد أو أكثر من مصادر البيانات داخل مشروع محدد. هذا الأمر يساعد في تحليل ومراقبة البيانات خلال فترة زمنية محددة. بعد اكتمال الفحص، يتم إرجاع قيمة نظام إشارات المرور المحسوبة:
- 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 CLI يُستخدم لإنشاء الملفات التعريفية (profiles)، التنبؤات (predictions)، وبيانات نظام إشارات المرور لواحد أو أكثر من مصادر البيانات داخل مشروع محدد. يساعد هذا الأمر في تحليل ومراقبة البيانات خلال فترة زمنية محددة. على عكس أمر 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 CLI يُستخدم للتحقق من تقدم فحص غير متزامن اعتمادًا على معرف الطلب.

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

dignacli inspect-status <REQUEST ID>

الوسائط

  • REQUEST_ID: معرف الطلب الذي أعاده أمر inspect-async

مثال

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

dignacli inspect-status 12345

inspect-cancel

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

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

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 CLI يُستخدم لإنشاء تصدير لمصادر البيانات من مستودع 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 CLI يُستخدم لاستيراد مصادر البيانات إلى مشروع مستهدف وإنشاء تقرير استيراد.

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

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 CLI يُستخدم لتحليل ملف تصدير مصادر البيانات قبل الاستيراد وإنشاء تقرير خطّة الاستيراد.

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

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

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