FlipLink CLI
أنشئ كتبك التفاعلية واضبطها وانشرها وأدِرها من سطر الأوامر أو من بيئة CI — غلاف رفيع قابل للبرمجة فوق واجهة FlipLink REST API.
يُثبَّت عبر npm · 87 أمراً · مخرجات JSON قابلة للبرمجة
التثبيت
npm install -g fliplink-cli
# or run without installing:
npx fliplink-cli whoamiيتطلّب Node.js 18 أو أحدث.
المصادقة
احصل على مفتاح API من لوحة تحكم FlipLink ← الاشتراك، ثم خزّنه:
fliplink config set-key YOUR_API_KEY
fliplink whoamiأو مرّره مع كل استدعاء (مفيد في CI — ولا يُكتب على القرص أبداً):
FLIPLINK_API_KEY=YOUR_API_KEY fliplink flipbook listترتيب الأولوية لكل إعداد: متغير البيئة ← ملف الإعدادات ← القيمة الافتراضية المدمجة. ويُخزَّن المفتاح في ~/.config/fliplink/config.json بصلاحيات chmod 600.
الأوامر الشائعة
fliplink flipbook create ./deck.pdf --title "Q3 Report" --name q3
fliplink flipbook create-url https://example.com/deck.pdf --title "Q3 Report"
fliplink flipbook list --search report --page-size 25 --sort-by CreatedOn
fliplink flipbook get <flipbookId>
fliplink flipbook publish <flipbookId>
fliplink flipbook unpublish <flipbookId>
fliplink flipbook set-expiry <flipbookId> --days 30
fliplink flipbook share-link <flipbookId>
fliplink flipbook delete <flipbookId>
fliplink leads list --item <flipbookId> --download trueشغّل fliplink <command> --help لمعرفة خيارات أي أمر.
كل مجموعات الأوامر
كل نقطة نهاية متاحة على هيئة أمر مُسمّى. شغّل fliplink <group> --help لعرض أوامر أي مجموعة.
| المجموعة | ما تشمله |
|---|---|
| flipbook | الإنشاء / القراءة / التعديل / الحذف + كل إعدادات الكتاب التفاعلي (المظهر، أزرار الحث على الإجراء، التقاط العملاء المحتملين، الوصول، المشاركة، المبيعات، التتبع، …) |
| profile | get، set |
| account | الاشتراك، المدفوعات |
| folder | list |
| cname | add، list، delete (النطاقات المخصصة) |
| team | list، get، set، set-active، delete |
| leads | list، delete، delete-bulk |
| sales | list |
| lookup | القوالب، المظاهر، العملات، الموسيقى الخلفية |
تستخدم نقاط نهاية Google Sheets عنوان أساس مختلفاً، ولا يمكن الوصول إليها إلا عبر منفذ api الاحتياطي.
البرمجة النصية
يطبع كل أمر جدولاً مقروءاً افتراضياً، ويطبع JSON خاماً مع --json:
fliplink flipbook list --json | jq '.[].ID'رموز الخروج: 0 نجاح · 1 خطأ في الطلب/HTTP · 2 خطأ في التطبيق (Result: ERROR).
الإكمال التلقائي في الصدفة
أنشئ سكربت إكمال تلقائي لصدفتك:
source <(fliplink completion zsh) # add to ~/.zshrc
source <(fliplink completion bash) # add to ~/.bashrcالمنفذ الاحتياطي — كل نقطة نهاية، اليوم
يمكن الوصول مباشرةً إلى أي نقطة نهاية لم تُغلَّف بعد في أمر سهل الاستخدام:
fliplink api GET /api/list-folders
fliplink api PUT /api/set-skin/<flipbookId> --data '{"SkinName":"Modern"}'
fliplink api POST /api/create-by-file --file File=./deck.pdf -q Name=deckتصفّح كل نقطة نهاية ومعاملاتها واستجاباتها في مرجع REST API الكامل.
كيف يعمل
تُولَّد واجهة الأوامر من مواصفات الواجهة — ملف endpoints.json نفسه الذي يشغّل وثائق REST API — فلا يمكن أن يبتعد CLI عن الواجهة الموثّقة. أتفضّل اللغة الطبيعية؟ الواجهة نفسها متاحة أيضاً على هيئة خادم MCP للمساعدين الأذكياء.
الأسئلة الشائعة
- كيف أُثبّت أداة FlipLink CLI؟
نفّذ
npm install -g fliplink-cli(تتطلب Node.js 18+)، أو استخدمها دون تثبيت عبرnpx fliplink-cli whoami.- كيف أُصادِق في نظام CI؟
مرّر مفتاحك بوصفه متغيّر بيئة
FLIPLINK_API_KEY— مثلًاFLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. ولا يُكتَب أبدًا على القرص. ومحليًا يمكنك تخزينه مرة واحدة عبرfliplink config set-key.- ما هي واجهة API الاحتياطية؟
أي واجهة لم تُغلَّف بعد في أمر مُيسَّر يمكن الوصول إليها مباشرةً عبر
fliplink api <METHOD> <path>، فتُغطّي الأداة كامل REST API منذ اليوم الأول.- هل يمكنني برمجة الأداة في سكربتات؟
نعم. يطبع كل أمر جدولًا افتراضيًا، أو JSON خامًا عبر
--json(مرّره إلىjq). ورموز الخروج قابلة للبرمجة:0نجاح، و1خطأ في الطلب أو HTTP، و2خطأ في التطبيق (Result: ERROR).- كم عدد الأوامر المتوفّرة؟
87 أمرًا موزّعة على 9 مجموعات (flipbook, profile, account, folder, cname, team, leads, sales, lookup)، مولّدة من مواصفات الـ API نفسها التي يُولَّد منها REST API، فلا يمكن أن تنحرف الأداة عن الواجهات الموثّقة.