راهنمای Appsan-CLI

راهنمای استفاده از ابزار خط فرمان CLI برای Appsan

این ابزار CLI به شما امکان مدیریت، اجرا، و تعامل با پروژه‌های Appsan را می‌دهد. دستورات اصلی در CLI عبارت‌اند از:

---

1. Run (اجرا)

برای اجرای پروژه Appsan:

java -jar AppsanCLI.jar run [options]

گزینه‌ها:

• -pl یا --platform: پلتفرم اجرا (مقدار: usb, web).
• -f یا --file: نام فایل XML که باید اجرا شود.
• -r یا --root: مسیر پوشه پروژه.
• -k یا --keyVal: جایگزینی کلید و مقدار
• -v یا --variable: افزودن یک متغیر به انتهای فایل.
• -o یا --out: مسیر خروجی.
• --debug: فعال‌سازی حالت دیباگ.
• --adb-path: مسیر ADB برای دستگاه‌های اندروید.
• --port: پورت برای پیش‌نمایش. (حالت وب)
• --socket-port: پورت برای اتصال WebSocket. (حالت وب)
• --keep-comments: حفظ کامنت‌ها در زمان بیلد.

---

2. Bundle (باندل کردن)

برای ایجاد بسته‌های باندل:

java -jar AppsanCLI.jar bundle [options]

گزینه‌ها:

• -f یا --file: نام فایل XML.
• -r یا --root: مسیر ریشه منابع.
• -k یا --keyVal: جایگزینی کلید و مقدار.
• -v یا --variable: افزودن متغیر.
• -q یا --qualifier: افزودن خصوصیات.
• -b یا --bundle-type: نوع باندل (zip, xml).
• --keep-comments: حفظ کامنت‌ها.

---

3. Devices (مدیریت دستگاه‌ها)

برای نمایش لیست دستگاه‌های متصل:

java -jar AppsanCLI.jar devices

---

4. Logs (دریافت لاگ‌ها)

برای مشاهده و مدیریت لاگ‌های پروژه:

java -jar AppsanCLI.jar logs [options]

گزینه‌ها:

• -d یا --device: انتخاب دستگاه برای مشاهده لاگ.

---

5. Exit Bridge (خروج از رابط اندروید tcp-bridge)

برای ارسال دستور خروج به پل ارتباطی:

java -jar AppsanCLI.jar exit-bridge

---

نکات اضافی:

• نصب: برای استفاده از این CLI، اطمینان حاصل کنید که جاوا ۱۱ یا بالاتر نصب شده باشد.
• پیکربندی: فایل appsan.json باید در مسیر پروژه موجود باشد تا تنظیمات پروژه به‌درستی بارگذاری شود.
• اشکال‌زدایی: در صورت وقوع خطا، از گزینه‌های دیباگ برای دریافت اطلاعات بیشتر استفاده کنید.

مثال‌ها:

• اجرای پروژه روی پلتفرم وب:

java -jar AppsanCLI.jar run -pl web -f [project-dir]/layout/app.xml -r [project-dir]/layout

• ایجاد باندل ZIP:

java -jar AppsanCLI.jar bundle -b zip -f [project-dir]/layout/app.xml -r [project-dir]/layout

• نمایش دستگاه‌ها:

java -jar AppsanCLI.jar devices

• دریافت لاگ‌ها از دستگاه خاص:

java -jar AppsanCLI.jar logs -d device1