OpenWiki؛ مستندسازیِ کدت رو به ایجنت بسپار
خلاصهٔ کاملتر
OpenWiki یه ابزار خطفرمان (CLI) از لنگچینه که برای کدبیسِ تو مستندات مینویسه و اونها رو نگهداری میکنه، و بهطور خاص برای ایجنتها ساخته شده. نصبش با npm بهصورت گلوباله و با اجرای دستورِ init، مدل و کلید APIتو پیکربندی میکنی و بعد مستندات رو میسازه.
طبق مستندات، اگه هنوز ویکیای وجود نداشته باشه، مستنداتِ اولیه رو تو پوشهٔ openwiki/ میسازه و اگه از قبل باشه، همون رو بر اساس تغییراتِ مخزن تازه میکنه. بهصورت پیشفرض CLI بعد از هر اجرا باز میمونه تا بتونی پیامهای بعدی بفرستی، ولی با گزینهٔ -p (یا --print) یه اجرای تکمرحلهایِ غیرتعاملی داری که فقط خروجیِ نهایی رو چاپ میکنه. دستورِ --update هم مستنداتِ موجود رو بهروز میکنه.
یه نکتهٔ جالبش اینه که OpenWiki خودکار یه پرامپت به فایلهای AGENTS.md و CLAUDE.md اضافه میکنه تا به ایجنتِ کدنویسی بگه موقع جستوجوی کانتکست به این مستندات رجوع کنه؛ اگه این فایلها نباشن، خودش میسازتشون. تو اولین اجرای تعاملی، ارائهدهندهٔ استنتاج، کلید API و مدل رو تنظیم میکنی و بهصورت اختیاری میتونی کلید LangSmith هم بدی تا اجراها رو تریس کنی. این تنظیمات تو مسیر ~/.openwiki/.env روی دستگاهت ذخیره میشن.
برای اینکه مستندات همیشه بهروز بمونن، میشه یه GitHub Action به مخزن اضافه کرد که هر روز خودکار یه PR با آپدیت مستندات باز کنه. OpenWiki از چند ارائهدهنده مثل OpenRouter، Fireworks، Baseten، OpenAI و Anthropic بهصورت آماده پشتیبانی میکنه و چند مدل مثل GLM 5.2، Kimi K2.6 و Sonnet 5 هم از پیش تعریف شدن، ضمن اینکه میشه شناسهٔ مدلِ دلخواه هم مشخص کرد.
نکات کلیدی:
- OpenWiki یه CLIِ متنبازِ لنگچینه که برای کدبیس مستندات مینویسه و نگهداری میکنه
- مخصوص ایجنتها ساخته شده و به AGENTS.md و CLAUDE.md اشاره اضافه میکنه
- مستندات رو تو پوشهٔ openwiki/ میسازه و از تغییرات مخزن بهروز نگه میداره
- با یه GitHub Action میشه هر روز خودکار PRِ آپدیت مستندات باز کرد
- از OpenAI، Anthropic، OpenRouter، Fireworks و Baseten و مدلهای دلخواه پشتیبانی میکنه




