تولید شده برای استدیوی هروف
Karen - CLI for Horuph

رابط خط فرمان کارن
جادو با تایپ چند کلمه

رابط خط فرمان یا CLI کارن ابزاری است که به توسعه دهنده با استدیوی هروف امکاناتی اضافه و در دسترسی ارائه می دهند که علاوه بر بالا بردن سهولت توسعه، عملیاتی چون پشتیبان گیری از پروژه یا افزونه در حال تولید، ذخیره ابری افزونه های با تعریف دسترسی و به روزرسانی بسته های افزونه در پایگاه ابری استدیوی هروف را فراهم می آورد.

سرعت بیشتر با CLI

رابط خط فرمان به شما کنترل بسیار بهتر و کامل‌تری را در اجرای برخی فرامین نسبت به سایر ابزار می‌دهد. چه در حال توسعه نرم افزار باشید و یا اینکه تنها سعی در انجام برخی دستورالعمل‌ها در پروژه بکنید، رابط خط فرمان به شما این اطمینان را می‌دهد که توانایی هر کاری را دارد.

قابل اجرا در تمامی سیستمهای عامل

Terminal
$
karen

کارن به عنوان بخشی از مجموعه استدیوی هروف، با فرامین کوتاه و قابل به خاطر سپاری دنیایی از امکانات متنوع را در اختیار توسعه دهنده قرار می دهد. این فرامین در تمامی سیستم های عامل یکپارچه و یک شکل فرا خوانده و عمل میکنند که این باعث سهولت بیشتر توسعه دهنده در انتخاب محیط توسعه خود است.

توسعه نرم افزار

رابط خط فرمان (CLI) در ادیتور های مدرن

در سال های اخیر با پخته تر شدن صنعت تولید و توسعه نرم افزار CLI ها در توسعه جای خود را دوباره یافته و تقریبا تمامی ادیتور های کد مدرن در کنار پنجره های خود، پنجره ای با عنوان Command prompt یا Terminal دارا هستند. این ترمینال یا محل اجرای فرامین خطی در کنار پروژه به توسعه دهنده امکان اجرا دستورات یا عمکرد های پیچیده تری را تنها با تایپ چند کلید واژه فراهم می کند.

رابط خط فرمان کارن در پنج نسخه برای تمامی سیستم های عامل کامپیوترهای شخصی (Windows [64bit, 32bit, ARM] - Linux [64bit, ARM] - MacOS) تولید شده و به صورت همزمان به روزرسانی می گردند.

نصب و راه اندازی

برای استفاده از کارن بر روی دستگاه خود مراحل زیر را دنبال کنید.

1. برای شروع به کار با رابط خط فرمان (CLI) کارن ابتدا نسخه مناسب برای سیستم عامل دستگاه مورد استفاده جهت توسعه را از اینجا دانلود کنید.

2. بسته دانلود شده را در پوشه مورد نظر خود باز (extract) کنید.

3. با دنبال کردن مراحل زیر کارن را به دستورات قابل اجرا در Terminal یا Command prompt تبدیل کنید.

Windows

برای قابل اجرا نمودن کارن بر روی دستگاه های ویندوز این مراحل را دنبال کنید.

On Windows OS:
  • Open the Start Menu.
  • Right-click on Computer and click Properties.
  • Click Advanced system settings.
  • Make sure you're on the Advanced tab.
  • Click Environment Variables.
  • Under System variables, scroll to find the Path Variable.
  • Click on Path and then click Edit.
  • Add the karen folder location to your Paths. These Paths are seperated with ;.
  • Right-click the karen folder and select Properties.
  • Click the Security tab to access the NTFS permissions.
  • On the "Group or user names" part, click the Edit button.
  • Click "add" in the Permissions window that just opened.
  • Click on "Select a principle" and write IIS_IUSRS in the name field and click on "Check names" then click on Ok.
  • On "Permission Entry", check all the basic permissions for this folder.
  • Click OK.
  • Click Apply.
  • Click OK to close the file or folder properties to complete the task.
MacOS

برای قابل اجرا نمودن کارن بر روی دستگاه های مک (Apple) این مراحل را دنبال کنید.

On MacOS OS:
  • Start up terminal.
  • Type "cd ~/" to go to your home folder.
  • Type "touch .bash_profile" to create your new file.
  • Edit .bash_profile with your favorite editor and add these lines to it:
    export KAREN_HOME="[YOUR_KAREN_LOCATION]"
    export PATH="${PATH}:${KAREN_HOME}"
        
  • Return to your terminal and navigate to root.
  • Type "sudo chmod 755 'karen'" to give permission to karen command.
  • Type "sudo chmod 755 'karen-update'" to give permission to karen-update command.

پس از دنبال کردن مراحل بالا، کارن بر روی دستگاه آماده کمک در توسعه و خلق نرم افزار و استارت آپ با استدیوی هروف است. برای آشنایی با فرامین خطی قابل اجرا توسط کارن در ترمینال های مختلف، ادامه مستندات را مطالعه کنید.

ترکیب کارن

دستورات و فرامین کارن متابق با استاندارت های سیستمهای Unix تولید شده تا فراگیری و پیشبینی دستورات برای توسعه دهندگان ساده تر و استفاده از آن نیاز به یادگیری کمتری داشته باشد.

دستورات و متغییر ها:

دستورات کارن به صورت کلمه کامل نوشته می شوند مانند install, remove یا update.


$ karen list
                                

متغییر یا ویژگی ها با -- در ابتدای نام انهای مشخص می شوند. مانند --addon, --version یا --user.

توجه داشته باشید که در صورتی که به این متغییر ها مقداری تعلق می گیرد حتما می بایست بعد از عنوان مقییر مقدار وارد شود.


$ karen remove --addon sample
$ karen remove --addon=sample
$ karen unpack --addon sample --version 0.9.000
                        
ترتیب فرامین:

دستورات کارن به هر ترتیبی که نوشته شوند برای کارن قابل اجرا است فقط توجه داشته باشید که متغییر ها و مقادیر مرتبط با آنها می بایست پشت هم نوشته شوند.


$ karen unpack --addon sample --version 0.9.000
$ karen --addon sample unpack --version 0.9.000
$ karen --addon sample --version 0.9.000 unpack
                        

دستورات پایه

دستورات و فرانین خطی کارن از عبارات زیر تشکیل شده که می توانند به صورت تک تک و یا ترکیبی با هم در ترمینال وارد و اجرا شوند.

دریافت راهنما و اطلاعات:

این دستورات همانطور که از نامشان انتظار دارید رفتار می کنند و اطلاعات مخطلف را در اختیار شما قرار می دهند.


$ karen -h | --help | help
$ karen --version
$ karen --info
                                
نصب فریم ورک استدیوی هروف:

به وسیله این دستور می توانید آخرین نسخه فریم ورک استدیوی هروف یا نسخه مورد نظر خود را در پوشه ای که هستید نصب کنید.


$ karen install --horuph --lang [language name]
$ karen install --horuph --lang [language name] --version [version]
                        
نصب زبان در فریم ورک:

برای نصب بسته های زبان اضافه بر روی فریم ورک استدیوی هروف از این دستور می توانید استفاده کنید.


$ karen install --lang [language name]
$ karen install --lang [language name] --version [version]
                        
نصب افزونه ها:

برای دسترسی و نصب افزونه ها از طریق CLI این دستورات توسط کارن قابل اجرا است.

توجه داشته باشید که برای وارد کردن نام افزونه، نام کامل repo.info باید برای مقدار --addon وارد شود.


$ karen install --addon [addon name]
$ karen install --addon [addon name] --version [version]
$ karen install --addon [addon name] --version [version] -f
                        

* در اجرای دستورات -f برای مجبور کردن به انجام عملی توسط کارن استفاده می شود.

نصب SDK ها:

برای دسترسی و نصب SDK ها از طریق CLI این دستورات توسط کارن قابل اجرا است.

توجه داشته باشید که نام SDK را باید برای مقدار --sdk وارد شود.


$ karen install --sdk [SDK name]
                        
به روز رسانی:

در فریم ورک استدیوی هروف علاوه بر فریم ورک، افزونه ها و دیکشنری های زبان نیز دارای نسخه هستند و از این رو قابل به روز رسانی می باشند.

برای به روز رسانی بخش های مختلف فریم ورک می توانید از این دستورات استفاده کنید.


$ karen update --horuph
$ karen update --horuph --version [version] -f
$ karen update --addons
$ karen update --addons -f
$ karen update --languages
$ karen update --languages -f
$ karen update --he
$ karen update --heui
                        

همچنین شما می توانید تنها یکی از افزونه ها و یا دیکشنری های زبان را به روز رسانی نمایید.

این به روزرسانی ها می تواند با انتخاب نسخه برای افزونه یا دیکشنری زبان صورت بگیرند.


$ karen update --lang [language name] 
$ karen update --lang [language name] --version [version] -f
$ karen update --addon [addon name] 
$ karen update --addon [addon name] --version [version] -f
                        
حذف افزونه ها و زبانها:

برای حذف یک زبان از فریم ورک یا حذف افزونه های این دستورات قابل اجرا هستند.


$ karen remove --lang [language name] 
$ karen remove --addon [addon name] 
$ karen remove addons 
                        
تهیه فهرست از فریم ورک:

برای دریافت گزارش و فهرست افزونه ها و زبانهای نصب شده می توانید از این دستورات استفاده کنید.


$ karen list
$ karen list --languages
$ karen list --addons
                        

پشتیبانگیری و بازگردانی

یکی از مهمترین مسئولیت های کارن در مجموعه استدیوی هروف تهیه نسخه های پشتیبان از افزونه ها و بازگردانی نسخه پشتیبان گیری شده است. این نسخه های پشتیبان در پوشه _packages در پوشه بالای پوشه پروژه بر اساس شماره نسخه ذخیره می شوند.

پشتیبانگیری از افزونه:

توسط این فرامین کارن برای شما از نسخه موجود افزونه نسخه پشتیبان در دستگاه شما می سازد که حتی در صورت حذف تمامی فایل های افزونه کارن امکان بازگردانی نسخه پشتیبانگیری شده را دارد.


$ karen pack --addon [addon name]
$ karen pack --addon [addon name] -f
$ karen pack --addons
$ karen pack --addons -f
                            

به وسیله این دستور شما می توانید از تمامی افزونه ها با یک بار دستور وارد کردن نسخه پشتیبان تهیه کنید.


$ karen pack --addons
$ karen pack --addons -f
                            
بازگردانی نسخه پشتیبان:

افزونه های پشتیبانگیری شده را می توانید با استفاده از این دستورات دوباره به پروژه بازگردانید. به صورت پیش فرض کارن همیشه آخرین نسخه را باز میگرداند.


$ karen unpack --addon [addon name]
$ karen unpack --addon [addon name] -f --version [version]
                            

با این دستور همه افزونه های پشتیبانگیری شده را یکجا باز میگردند.


$ karen unpack --addons
$ karen unpack --addons -f
                            
پشتیبانگیری از کل پروژه:

این دستور به شما امکان ذخیره سازی نسخه پشتیبان از کل پروژه را می دهد و قایل پشتیبان را در پوشه بالای پروژه ذخیره می کند که شما امکان آدرس دهی برای ذخیره را نیز دارید.


$ karen backup|--backup [folder]
                                

قالب های ساخت افزونه

این دستورات برای کمک به توسعه دهنده و افزودن سرعت توسعه افزونه های جدید در اختیار توسعه دهنده قرار دارند تا تنها با تایپ چند کلمه بتواند از قالب های پیش فرض فرم ها، صفحات و ... برای توسعه افزونه خود استفاده کند.

ساخت افزونه:

با استفاده از دستور create تنها با نام گذاری شما می توانید افزونه مورد نظر خود را تولید و شروع به توسعه کنید.

در صورتی که افزونه ای با نام ذکر شده وجود نداشته باشد، این دستور تمامی فایل ها و پوشه های لازم برای توسعه افزونه را می سازد.

ویژگی ها:

افزونه های می توانند دارای ویژگی های متفاوتی باشند که این قالب پیش فرض توسعه این ویژگی ها با معرفی مقدار پس از متغییر --feature قابل درخواست است.

این ویژگی ها بعد از ساخت افزونه نیز قابل اضافه شدن به افزونه هستند.


$ karen create --addon [addon name]
$ karen create --addon [addon name] --feature settings
$ karen create --addon [addon name] --feature toolbar
$ karen create --addon [addon name] --feature console
$ karen create --addon [addon name] --feature pages
$ karen create --addon [addon name] --feature webparts
$ karen create --addon [addon name] --feature sqlite
$ karen create --addon [addon name] --feature cartable
$ karen create --addon [addon name] --feature users
$ karen create --addon [addon name] --feature sitemap
$ karen create --addon [addon name] --feature report
$ karen create --addon [addon name] --feature console,pages,webparts
                            

پشتیبانگیری در پایگاه ابری

از بخش های مجموعه استدیوی هروف، Repository برای ذخیره بسته ها و نسخ تکه های مختلف فریم ورک استدیوی هروف است. بسته های توسعه داده شده را می توانید در پایگاه ابری استدیوی هروف بارگذاری کنید و بر روی پروژه های خود تنها با یک کلیک نصب کنید یا به روز رسانی کنید.

بارگذاری در پایگاه ابری:

به وسیله این دستور می توانید افزونه خود را در پایگاه ابری ذخیره کنید. به صورت پیش فرض دستری به افزونه تنها برای توسعه دهنده مجاز است ولی در صورت تمایل می توانید افزونه خود را با سایر توسعه دهندگان به اشتراک بگذارید.


$ karen publish --addon [addon name]
$ karen publish --addon [addon name] --access [public or public]
                                
گزارش از پایگاه ابری:

این دستورات به توسعه دهنده امکان دریافت گزارش از افزونه های بارگزاری شده و خود یا دیگران را می دهد.

همچنین به وسیله این دستور می توانید نسخ مختلف افزونه که بارگزاری شده است را گزارش گیری کنید.


$ karen list-repo
$ karen list-repo --user [username]
$ karen list-repo --user [username] --addon [addon name]
$ karen list-repo --addon [addon name] (repo.info name or unique name)
                                

با این دستور می توانید دسترسی سایر توسعه دهندگان به افزونه خود را تغییر دهید.


$ karen list-repo --addon [addon name] --access [public or public]
                            
حذف از پایگاه ابری:

به وسیله این دستورات می توانید نسخه یا کل افزونه بارگزاری شده در پایگاه ابری استدیوی هروف را حذف کنید.


$ karen unpublish --addon [addon name] --version [version]
$ karen unpublish --addon [addon name] -a
                                

توسعه فریم ورک هروف

کارن علاوه بر کمک به توسعه افزونه های فریم ورک استدیوی هروف، در تولید و توسعه فریم ورک نیز نقش مهمی دارد و تمامی بارگزاری ها و به روزرسانی های این فریم ورک نیز به وسیله کارن انجام می پزیرد.

دستورات اختصاصی:

این دستورات اختصاصی بوده و برای تنها برای توسعه فریم ورک استدیوی هروف است و سایر توسعه دهنگان به پایگاه ابری دسترسی ندارند.

این دستورات برای Demo امکانات کارن قرار گرفته و برای سایر توسعه دهندگان افزونه ها کاربردی ندارد.


$ karen pack --horuph
$ karen pack --horuph -f
$ karen pack --langpack --version [version]
$ karen pack --langpack --version [version] -f
$ karen pack --lang [language name]
$ karen pack --lang [language name] -f
$ karen publish --horuph
$ karen publish --langpack --version [version]
$ karen publish --lang [language name]
                                

به روزرسانی کارن

تیم توسعه استدیوی هروف هر روز در حال استفاده از کارن هستند و همیشه نظرات و پیشنهادات دیگر کاربران کارن را پیگیری و رسد می کنند، به همین خاطر کارن به صورت مستمر در حال به روزرسانی است و مشکلات و نواقص آن به سرعت مرتفع می گردد.

برای به روزرسانی کارن در دستگاه خود تنها نیاز دارید که مانند این مثال تایپ کنید.


$ karen-update
                        
کارن بخشی از نرم افزار های استدیوی هروف برای توسعه و تولید نرم افزارهای تحت وب است و برای سهولت و در دسترسی بودن امکانات در اهتیار توسعه دهندگان قرار گرفته است.

ساخته شده با تکنولوژی .NET Core توسط علی پورناصح برای استدیوی هروف.

آخرین نسخه رابط فرامین خطی کارن v2.250 است که می توانید از اینجا دریافت کنید.

تولید شده برای