Loading documentation…
مرجع دستورهای CLI ابران
دستورها، aliasها، flagهای عمومی و نمونه‌های CLI ابران برای App، دیتابیس، پروژه، token، لاگ و deployment.
آخرین بازبینی:
این صفحه مفید بود؟
بازخورد شما به بهترشدن مستندات کمک می‌کند.
دستورها، aliasها، flagهای عمومی و نمونه‌های CLI ابران برای App، دیتابیس، پروژه، token، لاگ و deployment.
آخرین بازبینی:
Loading documentation…
این صفحه مفید بود؟
بازخورد شما به بهترشدن مستندات کمک می‌کند.
این صفحه نقشه عملی commandهای abrun است. برای نصب و اولین login، ابتدا راهنمای نصب CLI را بخوانید.
abrun [global options] <command> [command options]برای دیدن راهنمای همان نسخه‌ای که نصب کرده‌اید:
abrun --help
abrun app --help
abrun app logs --helpراهنمای محلی CLI هنگام اختلاف نسخه، مرجع دقیق flagهای قابل اجرا است.
گزینه عمومی باید پیش از command قرار بگیرد؛ برای مثال abrun --project demo --json apps.
| گزینه | کاربرد |
|---|---|
--endpoint <url> | تغییر API endpoint برای همان اجرا |
--auth <auth> | انتخاب موقت یکی از loginهای ذخیره‌شده |
--project <project> | انتخاب موقت پروژه با ID، slug یا نام |
--token <token> | استفاده موقت از bearer token |
-o, --output <format> | خروجی table، json یا yaml |
--json | خروجی JSON خام برای automation |
--no-color | حذف رنگ‌های terminal |
--debug | نمایش اطلاعات بیشتر برای عیب‌یابی |
برای CI بهتر است token را در ABRUN_TOKEN و endpoint سفارشی را در ABRUN_ENDPOINT قرار دهید. secret را مستقیماً در command line ننویسید، چون ممکن است در process list و history دیده شود.
| command | کاربرد |
|---|---|
abrun login --browser | ورود با تأیید مرورگر |
abrun login | ورود تعاملی با ایمیل و رمز عبور |
abrun login --token <token> | ذخیره یک API token به‌عنوان login |
abrun whoami | نمایش هویت فعال |
abrun auth list | فهرست loginهای ذخیره‌شده؛ alias: auth ls |
abrun auth use <auth> | تغییر login فعال |
abrun auth remove <auth> | حذف login؛ alias: auth rm |
abrun logout | حذف login فعال |
abrun logout --all | حذف همه loginهای ذخیره‌شده |
loginها و پروژه انتخاب‌شده در ~/.abrun/config.yaml نگه‌داری می‌شوند. این فایل را commit یا بین کاربران share نکنید.
| command | کاربرد |
|---|---|
abrun project list | فهرست پروژه‌ها؛ alias: project ls |
abrun project use <project> | انتخاب پروژه با ID، slug یا نام |
abrun project current | نمایش پروژه فعال |
abrun token list | فهرست tokenها؛ alias: token ls |
abrun token get <token> | نمایش metadata یک token |
abrun token create <name> --expire 30d | ساخت token با زمان انقضا |
abrun token remove <token> | revoke کردن token؛ alias: token rm |
مقدار --expire می‌تواند زمان نسبی مانند 30d و 12h، مقدار never یا timestamp استاندارد ISO باشد. مقدار secret فقط هنگام ساخت نمایش داده می‌شود؛ همان لحظه آن را در secret store ذخیره کنید.
در commandهای زیر <app> نام یا شناسه App است.
| command | کاربرد |
|---|---|
abrun apps | فهرست Appهای پروژه |
abrun app list | همان فهرست؛ alias: app ls |
abrun app inspect <app> | جزئیات App؛ alias: app get |
abrun app create <name> --plan <plan> --port <port> | ساخت App |
abrun app update <app> | تغییر تنظیمات پشتیبانی‌شده App |
abrun app resize <app> --plan <plan> | تغییر plan |
abrun app start|stop|restart <app> | کنترل وضعیت runtime |
abrun app shell <app> | shell تعاملی؛ alias: app exec |
abrun app delete <app> | حذف App؛ alias: app rm |
برای ساخت و deploy، راهنمای استقرار اولین برنامه و پیکربندی build را دنبال کنید؛ گزینه‌های deploy به نوع source و نسخه CLI وابسته‌اند.
abrun app logs <app> --tail 200 --since 30m
abrun app logs <app> --filter 'error|timeout' --follow
abrun app events <app> --tail 50 --watchapp logs از --tail، --since، --filter، --previous و --follow پشتیبانی می‌کند. app events گزینه‌های --tail، --since و --watch دارد. تفاوت این سیگنال‌ها در راهنمای مانیتورینگ و Analytics توضیح داده شده است.
| command | کاربرد |
|---|---|
abrun app deployment list <app> | تاریخچه deployment؛ alias: deployment ls |
abrun app deployment inspect <app> <deployment> | جزئیات؛ alias: deployment get |
abrun app deployment logs <app> <deployment> | build و rollout output |
abrun app deployment watch <app> <deployment> | دنبال‌کردن وضعیت |
abrun app deployment cancel <app> <deployment> | لغو deployment در حال اجرا |
abrun app deployment rollback <app> <deployment> | بازگشت از deployment انتخاب‌شده به آخرین نسخه ready پیشین |
abrun app env list <app>
abrun app env set <app> KEY=value
abrun app env unset <app> KEY
abrun app disk list <app>
abrun app disk create <app> <name> --size 10
abrun app disk mount <app> <disk> /data
abrun app disk unmount <app> <disk>
abrun app disk expand <app> <disk> --size 20حذف دیسک با abrun app disk delete <app> <disk> انجام می‌شود و برگشت‌پذیر نیست. قبل از آن داده و backup موردنیاز را بررسی کنید. جزئیات lifecycle در راهنمای دیسک پایدار آمده است.
برای ساخت و انتخاب engine، از نام‌های postgres، mysql و redis استفاده کنید. database alias کوتاه db دارد.
| command | کاربرد |
|---|---|
abrun dbs یا abrun database list | فهرست دیتابیس‌ها |
abrun db inspect <database> | جزئیات دیتابیس؛ alias: db get |
abrun db engine list | engineها و versionهای قابل استفاده |
abrun db create <name> --engine postgres --plan <plan> | ساخت دیتابیس |
abrun db credentials <database> | نمایش credential با password پنهان |
abrun db tunnel <database> --port <port> | tunnel محلی TCP |
abrun db resize <database> --plan <plan> | تغییر plan |
abrun db start|stop <database> | کنترل وضعیت runtime |
abrun db metrics <database> | metricهای فعلی |
abrun db delete <database> | حذف دیتابیس؛ alias: db rm |
گزینه --reveal در command مربوط به credentials، password را به‌صورت plaintext چاپ می‌کند. فقط در terminal خصوصی استفاده کنید و خروجی را در log یا ticket قرار ندهید. برای اتصال امن، راهنمای اتصال دیتابیس را ببینید.
abrun db logs <database> --tail 200 --follow
abrun db events <database> --since 1h --watch
abrun db backup list <database>
abrun db backup create <database>
abrun db backup inspect <database> <backup>db logs همان filterهای اصلی App log را دارد. برای رفتار artifact و محدودیت‌های فعلی restore، راهنمای پشتیبان‌گیری دیتابیس را بخوانید.
برای scriptها از JSON استفاده کنید و exit code را بررسی کنید:
if apps_json="$(abrun --project <project> --json apps)"; then
printf '%s\n' "$apps_json" | jq '.items'
else
printf '%s\n' 'Could not list apps' >&2
exit 1
fiخروجی table برای انسان طراحی شده و قرارداد parsing نیست. از رنگ، ترتیب ستون‌ها یا متن خطا برای تصمیم‌گیری برنامه استفاده نکنید.
برای کار مستقیم با HTTP، شروع سریع API ابران را بخوانید. برای خطاهای login، پروژه، deploy، runtime و دیتابیس به راهنمای رفع مشکل بروید.