امروز نسخه 0.1.0 Explainer.js منتشر می شود. یک ابزار CLI برای پردازش فایل ها و خروجی بلوک های کد همراه با توضیح با استفاده از یک LLM. با استفاده از Commander.js و Groq SDK در جاوا اسکریپت ساخته شده است!
هفته گذشته روی آن کار کردم و بالاخره آن را برای انتشار نسخه 0.1.0 آماده کردم. این یک پروژه منبع باز است که من وظیفه داشتم آن را برای خودم بسازم Topics in Open Source Development. اگر متوجه شدید که در حال خواندن برخی از کدها هستید و برایتان مهم نیست که چگونه آن را انجام می دهد، اما فقط می خواهید بدانید که چه کاری انجام می دهد (مثل من) این ابزار بسیار مفید است. اگر می‌خواهید بدانید چگونه از آن استفاده کنید به خواندن ادامه دهید یا اگر می‌خواهید خودتان آن را بررسی کنید، می‌توانید از README.md دقیق (و رسمی) دیدن کرده و آن را بررسی کنید.
https://github.com/aamfahim/explainer.js
برخی از پیش نیازها
- آخرین نسخه پایدار (LTS) node.js را نصب کرده باشید.
- اختیاری: معتبر
.envفایل با اعتبارنامه API با تمام تایپ کردن. - اگر می‌خواهید از مدل سفارشی یا API استفاده کنید، Groq Documentation را بررسی کنید زیرا Groq همه چیز را پشتیبانی نمی‌کند. اگر مطمئن نیستید به پیش فرض بچسبید! تنها چیزی که نیاز دارید یک کلید Groq API است که بدست آوردن آن بسیار آسان است.
چگونه به
اگر می خواهید بررسی کنید که چگونه کار می کند، می توانید امتحان کنید
node index.js examples/bubble_sort.js
بعد از node index.js برای مثال می توانید نام مسیر/های خود را تعریف کنید
node index.js ../../../project/src/index.js
یا می توانید چندین فایل را همزمان تعریف کنید
node index.js ../../project/src/index.js ../../project2/src/index.js
من پیشنهاد می کنم یک فایل خروجی تعریف کنید تا اگر فایل شما خیلی طولانی است یا چندین فایل را تعریف می کنید، خروجی را به آن تخلیه کنید.
node index.js ../project/src/index.js ../../project2/src/index.js -o output.md
در اینجا لیستی از گزینه های موجود در دسترس شما از امروز آمده است.
گزینه ها
-
-a, --api-key: (الزامی) کلید API مورد استفاده برای پردازش. قابل تنظیم از طریق.envفایل (API_KEY) یا به عنوان آرگومان خط فرمان ارسال می شود. -
-b, --baseURL: URL پایه برای API. پیش فرض:https://api.groq.com/. -
-m, --model: نام مدلی که برای پردازش استفاده می شود. پیش فرض:llama-3.1-70b-versatile. -
-o, --output: مسیر فایل خروجی که نتایج در آن ذخیره خواهد شد. -
-t, --temperature: دمای مدل، از 0 تا 2 متغیر است. پیش فرض:1. -
-u, --token-usage: نمایش تعداد نشانه هایی که در دستور ارسال شده اند و تعداد نشانه هایی که برگردانده شده اند. پیش فرض:false. -
-h, --help: نمایش پیام راهنما برای کاربر. -
-v, --version: نمایش نسخه فعلی ابزار.
افکار بسته
مخزن را بررسی کنید، اگر بازخوردی دارید یا اشکالی پیدا کردید، ابزار را امتحان کنید، مشکلی را ثبت کنید!
