اکوان
مستندات اکوان
مستندات/شروع کار

اولین گفتگو

اکوان را در یک پروژه اجرا کنید و نخستین کار واقعی را به آن بسپارید.

Akvan هنگام شروع، اگر داخل یک Git repository باشید، نزدیک‌ترین پوشه‌ای را که .git دارد به‌عنوان project_root در نظر می‌گیرد. مسیر اجرای فرمان هم به‌عنوان cwd در prompt ثبت می‌شود. بیشتر pathهای نسبی ابزارهای فایل و terminal نسبت به project_root تفسیر می‌شوند، پس بهتر است akvan را از مسیر اصلی repository اجرا کنید.

اجرای Akvan در project root

bash
cd path/to/your-project
akvan

منظور از project root همان فولدری است که کد اصلی پروژه و فایل‌هایی مثل .git، pyproject.toml، package.json یا پوشه‌های اصلی پروژه در آن قرار دارند. اجرای Akvan از مسیر اشتباه ممکن است باعث شود فایل‌ها یا commandها نسبت به مسیر دیگری تفسیر شوند.

پس از بازشدن محیط گفتگو، یک درخواست کوچک و قابل بررسی بنویسید؛ برای نمونه:

text
Review the structure of this project and tell me where the application's entry point is. Don't change any files for now.

این درخواست به شما اجازه می‌دهد پیش از سپردن تغییرات، درک Akvan از پروژه را ارزیابی کنید.

سپردن نخستین تغییر

درخواست خوب، نتیجهٔ موردنظر و محدودیت‌ها را روشن می‌کند:

text
Add a test for invalid input error handling in the parse_config function. Follow the existing test patterns and then run the related test.

Akvan می‌تواند فایل‌ها را بخواند، patch اعمال کند و تست بگیرد. تغییرات معمول داخل project_root معمولاً بدون approval انجام می‌شوند؛ برای write بیرون پروژه، تغییر فایل حساس یا command خطرناک از شما approval می‌خواهد.

Akvan sandbox واقعی نیست. commandهای terminal با دسترسی کاربر سیستم اجرا می‌شوند؛ approvalها را قبل از تأیید بخوانید.

اگر workflow تکرارشونده‌ای را در یک session انجام داده‌اید، می‌توانید با دستور /learn آن را به یک skill تبدیل کنید.

برای استفاده از /learn، باید session شامل مراحل انجام آن workflow باشد؛ یعنی یا workflow را در همین session انجام داده باشید، یا ابتدا با /resume یک session ذخیره‌شده را بارگذاری کنید.

برای اطلاعات بیشتر، راهنمای learn را ببینید.

کنترل گفتگو

  • Enter پیام را ارسال می‌کند.
  • Esc و سپس Enter خط تازه می‌سازد.
  • /exit یا Ctrl-D گفتگو را می‌بندد.
  • /sessions sessions ذخیره‌شده را نشان می‌دهد.
  • /resume 1 نخستین session فهرست فعلی را ادامه می‌دهد.

sessions به‌صورت محلی در ~/.akvan/state.db ذخیره می‌شوند.

اگر از provider akvan استفاده می‌کنید، پیش از کارهای طولانی موجودی اعتبار خود را بررسی کنید. راهنما: حساب Akvan و provider Akvan

قدم بعدی

برای دستورالعمل‌های دائمی پروژه، فایل .akvan.md یا AKVAN.md بسازید. اگر هیچ‌کدام پیدا نشوند، Akvan از AGENTS.md استفاده می‌کند.