مرجع CLI ابرکلیک

🖼

تصویر: مرجع دستورات CLI ابرکلیکplaceholder — تصویر را اینجا جایگزین کنید

این صفحه مرجع کامل دستورات CLI ابرکلیک است. برای نصب CLI به صفحه نصب CLI مراجعه کنید.

---

احراز هویت

abrclick login

وارد حساب ابرکلیک می‌شوید (مرورگر را باز می‌کند).

abrclick login [options]

فلگ	توضیح
--email <email>	ایمیل (با --password یا ABRCLICK_PASSWORD برای ورود headless استفاده کنید)
--password <password>	رمز عبور (ورود headless — ترجیحاً متغیر محیطی ABRCLICK_PASSWORD)
--no-browser	URL را چاپ کنید به‌جای باز کردن مرورگر

مثال:

abrclick login
abrclick login --email ali@example.com --password mypass
ABRCLICK_PASSWORD=mypass abrclick login --email ali@example.com

نکته

در محیط‌های بدون مرورگر (مانند سرور CI/CD) می‌توانید از متغیر محیطی ABRCLICK_TOKEN (با یک API key) استفاده کنید.

---

abrclick logout

از حساب خارج می‌شوید.

abrclick logout

---

abrclick whoami

کاربر فعلی را نمایش می‌دهد.

abrclick whoami

نمونه خروجی:

✔ ali@example.com
  نام:     علی احمدی
  پلن:     باران
  ناحیه:   ir-thr-1
  api:     https://api.abrclick.ir

---

abrclick auth keys create

یک API key برای استفاده headless / CI ایجاد می‌کند — key کامل یک بار نشان داده می‌شود.

abrclick auth keys create <name> [options]

فلگ	توضیح
--scope <scope...>	محدود کردن key: deploy | db | registry | admin (جدا شده با فاصله). حذف = دسترسی کامل.
--expires <date>	انقضا به عنوان یک تاریخ ISO (مثلاً 2027-01-01)

Scope‌ها (یک API key بدون هیچ‌کدام = دسترسی کامل حساب):

• deploy — build + deploy اپ‌ها (توصیه شده برای CI/CD)
• db — مدیریت دیتابیس‌ها
• registry — مدیریت رجیستری‌ها + خواندن creds
• admin — ایجاد / لغو API key‌ها

مثال:

abrclick auth keys create ci --scope deploy
abrclick auth keys create staging --scope deploy db --expires 2026-12-31

---

abrclick auth keys list

لیست API key‌ها را نمایش می‌دهد.

abrclick auth keys list

---

abrclick auth keys revoke

یک API key را لغو می‌کند.

abrclick auth keys revoke <id>

مثال:

abrclick auth keys revoke key_abc123xyz

---

پروژه‌ها

abrclick projects list

لیست پروژه‌ها را نمایش می‌دهد (در ترمینال به صورت تعاملی).

abrclick projects list [--no-interactive]

فلگ	توضیح
--no-interactive	جدول ساده چاپ کنید و خارج شوید (بدون picker)

---

abrclick projects create

یک پروژه جدید می‌سازد. پروژه، ظرف مشترک اپلیکیشن‌ها و پایگاه‌های داده شماست.

abrclick projects create --name <name>

فلگ	توضیح
--name <name>	نام پروژه (اجباری)

مثال:

abrclick projects create --name "پروژه من"

---

abrclick projects info

جزئیات پروژه را نمایش می‌دهد.

abrclick projects info <projectId>

مثال:

abrclick projects info proj_xyz789abc

---

abrclick projects rename

نام یک پروژه را تغییر می‌دهد.

abrclick projects rename <projectId> <name>

مثال:

abrclick projects rename proj_xyz789abc "نام جدید"

---

abrclick projects delete

یک پروژه (و تمام اپ‌ها، دیتابیس‌ها و داده‌های آن) را حذف می‌کند.

abrclick projects delete <projectId> [--yes]

فلگ	توضیح
--yes	رد شدن از تأیید

هشدار

این عملیات برگشت‌ناپذیر است. تمام اپ‌ها، دیتابیس‌ها و داده‌های داخل پروژه حذف خواهند شد.

مثال:

abrclick projects delete proj_xyz789abc

---

اتصال پروژه محلی

abrclick init

دایرکتوری جاری را برای deployment تنظیم می‌کند (abrclick.json می‌سازد).

abrclick init [--source <path>] [-y]

فلگ	توضیح	پیش‌فرض
--source <path>	دایرکتوری پروژه	.
-y, --yes	پذیرش پیش‌فرض‌های تشخیص داده شده بدون سوال

CLI به صورت تعاملی اطلاعات اپ را می‌پرسد (نام، پروژه، runtime، پورت). فایل abrclick.json ساخته می‌شود:

{
  "app": "app_abc123xyz",
  "project": "proj_xyz789abc",
  "runtime": "nodejs",
  "port": 3000
}

مثال:

abrclick init
abrclick init --source ./my-app -y

اطلاع

پس از اجرای abrclick init، دستور abrclick deploy بدون نیاز به فلگ اضافه کار می‌کند.

---

abrclick link

دایرکتوری جاری را به یک اپ موجود متصل می‌کند.

abrclick link --app <id> [--source <path>]

فلگ	توضیح	پیش‌فرض
--app <id>	شناسه اپ برای لینک (اجباری)	—
--source <path>	دایرکتوری پروژه	.

مثال:

abrclick link --app app_abc123xyz

اطلاع

فایل abrclick.json ایجاد یا به‌روز می‌شود.

---

اپلیکیشن‌ها

abrclick apps list

لیست اپ‌های یک پروژه را نمایش می‌دهد (در ترمینال به صورت تعاملی).

abrclick apps list [--project <id>] [--no-interactive]

فلگ	توضیح
--project <id>	فیلتر بر اساس پروژه (اختیاری؛ اگر abrclick.json وجود دارد خودکار تشخیص داده می‌شود)
--no-interactive	جدول ساده چاپ کنید و خارج شوید (بدون picker)

مثال:

abrclick apps list --project proj_xyz789

---

abrclick apps create

یک اپلیکیشن جدید می‌سازد.

abrclick apps create --name <name> --runtime <runtime> --port <port> [options]

فلگ	توضیح	پیش‌فرض
--project <id>	شناسه پروژه	از abrclick.json
--name <name>	نام اپ (اجباری)	—
--runtime <runtime>	نوع runtime (اجباری)	—
--hono-runtime <runtime>	برای --runtime hono: کدام runtime اجرا می‌شود (nodejs|bun|deno)	nodejs
--runtime-version <version>	نسخه toolchain (مثلاً 22، 3.12، 8.3). حذف = تشخیص خودکار	—
--port <port>	پورت داخلی اپ (1-65535) (اجباری)	—
--endpoint <spec...>	endpoint اضافی HTTP به صورت port :name ، مثلاً 8000:/ws:websocket (قابل تکرار)	—
--root-dir <path>	زیردایرکتوری monorepo بسته قابل deploy	—
--image <img>	deploy از یک image از پیش ساخته‌شده به‌جای build از سورس	—
--registry-user <user>	نام کاربری registry خصوصی (برای --image خصوصی)	—
--registry-pass <pass>	رمز/token registry خصوصی	—
--env-file <path>	بارگذاری متغیرهای محیطی از فایل .env بعد از ساخت اپ	—

رانتایم‌های پشتیبانی‌شده:

nodejs nextjs bun deno nuxt sveltekit astro react vue angular hono python django flask go php laravel dotnet static docker

مثال:

abrclick apps create --name my-api --runtime nodejs --port 8080
abrclick apps create --name my-site --runtime static --port 80
abrclick apps create --name my-ws --runtime nodejs --port 3000 --endpoint 8000:/ws:websocket

---

abrclick apps runtime-versions

لیست نسخه‌های قابل انتخاب toolchain runtime را نمایش می‌دهد (با پرچم‌های LTS).

abrclick apps runtime-versions

---

abrclick apps info

اطلاعات کامل یک اپ (وضعیت، آدرس، رانتایم، آخرین استقرار) را نمایش می‌دهد.

abrclick apps info [appId]

اگر appId داده نشود و abrclick.json در دایرکتوری جاری وجود داشته باشد، اپ متصل استفاده می‌شود.

مثال:

abrclick apps info
abrclick apps info app_abc123xyz

---

abrclick apps start

اپ متوقف‌شده را راه‌اندازی می‌کند.

abrclick apps start [appId]

---

abrclick apps stop

اپ در حال اجرا را متوقف می‌کند.

abrclick apps stop [appId]

---

abrclick apps restart

اپ را ری‌استارت می‌کند (بدون استقرار مجدد).

abrclick apps restart [appId]

---

abrclick apps delete

اپ و تمام منابع مرتبط (دیپلوی‌ها، لاگ‌ها) را حذف می‌کند.

abrclick apps delete [appId]

هشدار

این عملیات برگشت‌ناپذیر است.

---

abrclick apps logs

لاگ‌های build را برای آخرین deployment نمایش می‌دهد (پیش‌فرض از abrclick.json).

abrclick apps logs [appId] [--deployment <id>] [--no-follow]

فلگ	توضیح
--deployment <id>	شناسه deployment خاص (پیش‌فرض: آخرین)
--no-follow	چاپ لاگ‌های موجود و خروج (بدون polling)

مثال:

abrclick apps logs
abrclick apps logs app_abc123xyz --no-follow
abrclick apps logs --deployment dep_xyz789abc

---

abrclick apps runtime-logs

تاریخچه لاگ‌های runtime (container) را از Loki دریافت می‌کند — اپ در حال اجرا، نه build.

abrclick apps runtime-logs [appId] [--range <window>] [--limit <n>]

فلگ	توضیح	پیش‌فرض
--app <id>	شناسه اپ (یا خواندن از abrclick.json)	—
--range <window>	بازه زمانی، مثلاً 5m، 1h، 7d (محدود به پلن شما)	1h
--limit <n>	حداکثر خطوط (1-5000)	1000

مثال:

abrclick apps runtime-logs app_abc123xyz --range 7d --limit 500

---

abrclick apps deployments

تاریخچه deployment را نمایش می‌دهد (پیش‌فرض از abrclick.json).

abrclick apps deployments [appId] [--app <id>]

مثال:

abrclick apps deployments
abrclick apps deployments app_abc123xyz

---

abrclick apps rollback

به یک deployment موفق قبلی بازگردانید (image آن را مجدداً deploy می‌کند).

abrclick apps rollback <deployId> [appId] [--app <id>]

مثال:

abrclick apps rollback dep_xyz789abc app_abc123xyz

---

abrclick apps retry

یک build شکست‌خورده را با استفاده مجدد از سورس آپلود‌شده مجدداً امتحان می‌کند (بدون آپلود مجدد).

abrclick apps retry <deployId> [appId] [--app <id>]

مثال:

abrclick apps retry dep_xyz789abc

---

abrclick apps redeploy

image ساخته‌شده فعلی را بدون rebuild مجدداً deploy می‌کند.

abrclick apps redeploy [appId] [--app <id>]

مثال:

abrclick apps redeploy

---

abrclick apps scale

منابع اپ را به‌روز می‌کند (cpu، memory، replicas، autoscale).

abrclick apps scale [appId] [options]

فلگ	توضیح
--app <id>	شناسه اپ (یا خواندن از abrclick.json)
--cpu <limit>	محدودیت CPU، مثلاً 500m یا 1
--memory <limit>	محدودیت حافظه، مثلاً 512Mi یا 1Gi
--replicas <n>	تعداد replica ثابت (1-20)
--autoscale	فعال‌سازی autoscaling
--no-autoscale	غیرفعال‌سازی autoscaling
--min <n>	حداقل replicas برای autoscale
--max <n>	حداکثر replicas برای autoscale

مثال:

abrclick apps scale --cpu 1 --memory 1Gi
abrclick apps scale --autoscale --min 2 --max 10

---

abrclick apps links

لیست دیتابیس‌های متصل به این اپ را نمایش می‌دهد.

abrclick apps links [appId] [--app <id>]

مثال:

abrclick apps links app_abc123xyz

---

abrclick apps link-db

یک دیتابیس را به این اپ متصل می‌کند (متغیرهای محیطی DATABASE_* را تزریق می‌کند + redeploy می‌کند).

abrclick apps link-db <databaseId> [appId] [--app <id>] [--prefix <prefix>]

فلگ	توضیح	پیش‌فرض
--prefix <prefix>	پیشوند متغیر محیطی	DATABASE

مثال:

abrclick apps link-db db_a1b2c3d4 app_abc123xyz --prefix POSTGRES

---

abrclick apps unlink-db

اتصال یک دیتابیس را قطع می‌کند (متغیرهای محیطی تزریق‌شده را حذف می‌کند + redeploy می‌کند).

abrclick apps unlink-db <linkId> [appId] [--app <id>]

مثال:

abrclick apps unlink-db link_xyz789

---

abrclick apps domains list

لیست دامنه‌های سفارشی را نمایش می‌دهد.

abrclick apps domains list [appId] [--app <id>]

---

abrclick apps domains add

یک دامنه سفارشی اضافه می‌کند.

abrclick apps domains add <domain> [appId] [--app <id>]

مثال:

abrclick apps domains add example.com app_abc123xyz

---

abrclick apps domains verify

DNS یک دامنه را تأیید می‌کند که به اینجا اشاره دارد.

abrclick apps domains verify <domainId> [appId] [--app <id>]

مثال:

abrclick apps domains verify dom_xyz789 app_abc123xyz

---

abrclick apps domains remove

یک دامنه سفارشی را حذف می‌کند.

abrclick apps domains remove <domainId> [appId] [--app <id>]

هشدار

دامنه از ingress حذف می‌شود.

---

abrclick apps webhook show

URL webhook deploy را نمایش می‌دهد (اگر یک secret تنظیم شده باشد).

abrclick apps webhook show [appId] [--app <id>]

---

abrclick apps webhook rotate

secret webhook را تولید یا rotate می‌کند (متن ساده یک بار نشان داده می‌شود).

abrclick apps webhook rotate [appId] [--app <id>]

مثال:

abrclick apps webhook rotate app_abc123xyz

---

استقرار

abrclick deploy

یک اپ را deploy می‌کند.

abrclick deploy [options]

فلگ	توضیح	پیش‌فرض
--app <id>	شناسه اپ (یا خواندن از abrclick.json)	—
--source <path>	دایرکتوری سورس	.
--image <img>	deploy یک تگ image از پیش ساخته‌شده به‌جای	—
--registry-user <user>	نام کاربری registry خصوصی (برای --image خصوصی؛ حذف برای استفاده مجدد از creds ذخیره‌شده اپ)	—
--registry-pass <pass>	رمز/token registry خصوصی (برای --image خصوصی)	—
--root-dir <path>	زیردایرکتوری monorepo برای deploy (تنظیمات اپ را قبل از build به‌روز می‌کند)	—
--force	rebuild حتی اگر سورس از آخرین deploy تغییر نکرده باشد	—
--no-follow	لاگ‌های build را stream نکنید؛ بعد از صف‌بندی برگردید	—

مثال‌ها:

# استقرار ساده (با abrclick.json)
abrclick deploy

# استقرار با شناسه اپ
abrclick deploy --app app_abc123xyz

# استقرار از یک پوشه دیگر
abrclick deploy --app app_abc123xyz --source ./my-app

# استقرار بدون دنبال کردن لاگ‌ها
abrclick deploy --no-follow

# استفاده از تصویر آماده
abrclick deploy --app app_abc123xyz --image ghcr.io/org/myapp:v1.2.0

# استقرار از یک زیردایرکتوری در monorepo
abrclick deploy --root-dir apps/backend

# force rebuild
abrclick deploy --force

اطلاع

حداکثر حجم tarball سورس ۱۰۰ مگابایت است. فایل .abrclickignore (مشابه .gitignore) برای حذف فایل‌های غیرضروری پشتیبانی می‌شود.

نکته

اگر Dockerfile در ریشه پروژه وجود نداشته باشد، سیستم buildpack به صورت خودکار runtime را تشخیص داده و یک Dockerfile مناسب می‌سازد.

---

پایگاه داده

abrclick db list

لیست دیتابیس‌های یک پروژه را نمایش می‌دهد (در ترمینال به صورت تعاملی).

abrclick db list [--project <id>] [--no-interactive]

فلگ	توضیح
--project <id>	فیلتر بر اساس پروژه (اختیاری)
--no-interactive	جدول ساده چاپ کنید و خارج شوید (بدون picker)

---

abrclick db create

یک دیتابیس مدیریت‌شده جدید می‌سازد.

abrclick db create --name <name> --type <type> [options]

فلگ	توضیح	پیش‌فرض
--project <id>	شناسه پروژه	از abrclick.json
--name <name>	نام دیتابیس (اجباری)	—
--type <type>	نوع دیتابیس (اجباری)	—
--version <version>	نسخه engine	auto
--storage <gb>	ذخیره‌سازی به گیگابایت	5
--cpu <limit>	محدودیت CPU، مثلاً 500m یا 1	—
--memory <limit>	محدودیت حافظه، مثلاً 512Mi یا 1Gi	—
--extension <name>	فقط Postgres: افزودن یک extension — 'pgvector' (embeddings) یا 'postgis' (geospatial)	—
--replica-set	فقط MongoDB: replica set تک-نودی (فعال‌سازی transactions، change streams، oplog)	—

انواع دیتابیس پشتیبانی‌شده:

postgres mysql mariadb mongo redis valkey memcached rabbitmq kafka elasticsearch meilisearch qdrant

مثال:

abrclick db create --name my-db --type postgres --storage 10
abrclick db create --name cache --type redis
abrclick db create --name vectors --type postgres --extension pgvector
abrclick db create --name docs --type mongo --replica-set

اطلاع

پس از ساخت دیتابیس، فرآیند provisioning ~90 ثانیه طول می‌کشد. وضعیت را با abrclick db info <dbId> دنبال کنید.

---

abrclick db info

اطلاعات یک دیتابیس (وضعیت، نوع، نسخه، فضای ذخیره‌سازی) را نمایش می‌دهد.

abrclick db info <dbId>

مثال:

abrclick db info db_a1b2c3d4

---

abrclick db credentials

اطلاعات اتصال (host، port، username، password، database name) را نمایش می‌دهد.

abrclick db credentials <dbId>

مثال:

abrclick db credentials db_a1b2c3d4

هشدار

اطلاعات اتصال حساس هستند. آن‌ها را در کد یا git commit ذخیره نکنید. از متغیرهای محیطی استفاده کنید.

---

abrclick db connect

یک shell تعاملی به دیتابیس باز می‌کند (psql / redis-cli / mongosh).

abrclick db connect <dbId>

مثال:

abrclick db connect db_a1b2c3d4

اطلاع

برای استفاده از این دستور، ابزار مربوطه (psql، redis-cli، mongosh، mysql) باید روی سیستم محلی شما نصب باشد.

---

abrclick db resize

تغییر اندازه دیتابیس — cpu، memory، storage (storage فقط رشد می‌کند).

abrclick db resize <dbId> [options]

فلگ	توضیح
--cpu <limit>	محدودیت CPU، مثلاً 500m یا 1
--memory <limit>	محدودیت حافظه، مثلاً 512Mi یا 1Gi
--storage <gb>	ذخیره‌سازی به GB (فقط می‌تواند افزایش یابد)

مثال:

abrclick db resize db_a1b2c3d4 --storage 20 --memory 2Gi

---

abrclick db logs

لاگ‌های provisioning را نمایش می‌دهد.

abrclick db logs <dbId>

مثال:

abrclick db logs db_a1b2c3d4

---

abrclick db public-access

دسترسی عمومی اینترنت را فعال یا غیرفعال می‌کند.

abrclick db public-access <dbId> [--disable]

فلگ	توضیح
--disable	غیرفعال‌سازی دسترسی عمومی (پیش‌فرض: فعال)

مثال:

abrclick db public-access db_a1b2c3d4
abrclick db public-access db_a1b2c3d4 --disable

---

abrclick db delete

دیتابیس و تمام داده‌های آن را حذف می‌کند.

abrclick db delete <dbId>

هشدار

این عملیات برگشت‌ناپذیر است. تمام داده‌ها پاک خواهند شد.

---

abrclick db backups list

لیست پشتیبان‌گیری‌ها برای یک دیتابیس را نمایش می‌دهد.

abrclick db backups list <dbId>

مثال:

abrclick db backups list db_a1b2c3d4

---

abrclick db backups create

یک پشتیبان‌گیری دستی ایجاد می‌کند.

abrclick db backups create <dbId>

مثال:

abrclick db backups create db_a1b2c3d4

---

abrclick db backups restore

یک پشتیبان را در همان دیتابیس بازیابی می‌کند (ویرانگر).

abrclick db backups restore <dbId> <backupId>

هشدار

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

مثال:

abrclick db backups restore db_a1b2c3d4 bkp_xyz789

---

abrclick db backups clone

یک دیتابیس جدید از این پشتیبان provision می‌کند.

abrclick db backups clone <dbId> <backupId> --name <name> [options]

فلگ	توضیح
--name <name>	نام دیتابیس clone‌شده (اجباری)
--cpu <limit>	محدودیت CPU
--memory <limit>	محدودیت حافظه
--storage <gb>	ذخیره‌سازی به GB

مثال:

abrclick db backups clone db_a1b2c3d4 bkp_xyz789 --name staging-db --storage 15

---

abrclick db backups schedule

برنامه پشتیبان‌گیری خودکار را تنظیم یا پاک می‌کند.

abrclick db backups schedule <dbId> [options]

فلگ	توضیح
--cron <expr>	Cron: '0 * * * *' هر ساعت، '0 2 * * *' روزانه، '0 2 * * 0' هفتگی، '0 2 1 * *' ماهانه
--clear	غیرفعال‌سازی پشتیبان‌گیری خودکار

مثال:

abrclick db backups schedule db_a1b2c3d4 --cron "0 2 * * *"
abrclick db backups schedule db_a1b2c3d4 --clear

---

abrclick db backups delete

یک پشتیبان را حذف می‌کند.

abrclick db backups delete <dbId> <backupId>

مثال:

abrclick db backups delete db_a1b2c3d4 bkp_xyz789

---

لاگ‌ها و کنترل

abrclick logs

لاگ‌های build را برای یک deployment stream می‌کند.

abrclick logs --app <id> --deployment <id> [--no-follow]

فلگ	توضیح
--app <id>	شناسه اپ (اجباری)
--deployment <id>	شناسه deployment (اجباری)
--no-follow	چاپ لاگ‌های موجود و خروج (بدون polling)

مثال:

abrclick logs --app app_abc123xyz --deployment dep_xyz789abc
abrclick logs --app app_abc123xyz --deployment dep_xyz789abc --no-follow

---

abrclick run

یک دستور یک‌بار در یک اپ در حال اجرا اجرا می‌کند.

abrclick run [--app <id>] <cmd...>

فلگ	توضیح
--app <id>	شناسه اپ (یا خواندن از abrclick.json)
<cmd...>	دستور و آرگومان‌ها برای اجرا (برای ویژگی‌های shell استفاده کنید: run sh -c "a | b")

مثال:

# اجرای migration دیتابیس
abrclick run -- npx prisma migrate deploy

# بررسی متغیرهای محیطی
abrclick run -- printenv

# اجرای یک اسکریپت پایتون
abrclick run -- python manage.py collectstatic

نکته

از -- قبل از دستور استفاده کنید تا فلگ‌های دستور با فلگ‌های CLI اشتباه گرفته نشوند.

---

abrclick shell

یک shell تعاملی در یک اپ در حال اجرا باز می‌کند.

abrclick shell [--app <id>]

فلگ	توضیح
--app <id>	شناسه اپ (یا خواندن از abrclick.json)

مثال:

abrclick shell
abrclick shell --app app_abc123xyz

اطلاع

این دستور نیاز دارد که اپ در حالت running باشد. برای اجرای دستورات موقت از abrclick run استفاده کنید.

---

رجیستری کانتینر

مدیریت رجیستری‌های خصوصی کانتینر — تصاویر خود را push کنید و با deploy --image مستقر نمایید.

abrclick registry list

لیست رجیستری‌های یک پروژه را نمایش می‌دهد.

abrclick registry list [--project <id>]

مثال:

abrclick registry list --project proj_xyz789

---

abrclick registry create

یک رجیستری کانتینر جدید می‌سازد.

abrclick registry create <name> --size <gb> [--public]

فلگ	توضیح	پیش‌فرض
--project <id>	شناسه پروژه	از abrclick.json
--size <gb>	اندازه رجیستری به GB (1GB رایگان) (اجباری)	—
--public	مجاز کردن pull بدون احراز هویت	false

مثال:

abrclick registry create my-registry --size 20
abrclick registry create public-images --size 10 --public

---

abrclick registry info

جزئیات رجیستری را نمایش می‌دهد.

abrclick registry info <id>

مثال:

abrclick registry info reg_abc123xyz

---

abrclick registry credentials

اطلاعات لاگین Docker را نمایش می‌دهد (کامل نمایش داده می‌شود — آن‌ها را محرمانه نگه دارید).

abrclick registry credentials <id>

مثال:

abrclick registry credentials reg_abc123xyz

---

abrclick registry login

Docker را به رجیستری لاگین می‌کند (رمز robot را مخفی می‌کند).

abrclick registry login <id>

مثال:

abrclick registry login reg_abc123xyz

---

abrclick registry rotate

secret robot رجیستری را rotate می‌کند (رمز قدیمی را باطل می‌کند).

abrclick registry rotate <id>

مثال:

abrclick registry rotate reg_abc123xyz

---

abrclick registry repos

لیست repository‌های image در رجیستری را نمایش می‌دهد.

abrclick registry repos <id>

مثال:

abrclick registry repos reg_abc123xyz

---

abrclick registry resize

اندازه یک رجیستری را تغییر می‌دهد — فقط رشد.

abrclick registry resize <id> --size <gb>

فلگ	توضیح
--size <gb>	اندازه جدید رجیستری به GB (فقط می‌تواند افزایش یابد) (اجباری)

مثال:

abrclick registry resize reg_abc123xyz --size 50

---

abrclick registry public

pull‌های ناشناس image را تغییر وضعیت می‌دهد.

abrclick registry public <id> [--enable | --disable]

فلگ	توضیح
--enable	مجاز کردن pull‌های ناشناس
--disable	نیاز به احراز هویت برای pull‌ها

مثال:

abrclick registry public reg_abc123xyz --enable
abrclick registry public reg_abc123xyz --disable

---

abrclick registry rm

یک رجیستری و تمام image‌های آن را حذف می‌کند.

abrclick registry rm <id>

هشدار

این عملیات برگشت‌ناپذیر است. تمام image‌ها حذف می‌شوند.

مثال:

abrclick registry rm reg_abc123xyz

---

کرون (Cron Jobs)

مدیریت وظایف زمان‌بندی‌شده (cron jobs) برای یک اپ.

abrclick cron create

یک cron job زمان‌بندی‌شده برای یک اپ می‌سازد.

abrclick cron create --name <name> --schedule <expr> --command <cmd> [options]

فلگ	توضیح
--app <id>	شناسه اپ (پیش‌فرض از abrclick.json)
--name <name>	نام cron job (اجباری)
--schedule <expr>	برنامه cron 5-فیلدی، مثلاً '0 2 * * *' (اجباری)
--command <cmd>	دستور برای اجرا در برنامه (اجباری)
--timezone <tz>	منطقه زمانی IANA، مثلاً Asia/Tehran
--disabled	job را غیرفعال ایجاد کنید

مثال:

abrclick cron create --name daily-backup --schedule "0 2 * * *" --command "npm run backup" --timezone Asia/Tehran
abrclick cron create --name hourly-cleanup --schedule "0 * * * *" --command "node cleanup.js"

---

abrclick cron list

لیست cron job‌های یک اپ را نمایش می‌دهد.

abrclick cron list [--app <id>]

مثال:

abrclick cron list
abrclick cron list --app app_abc123xyz

---

abrclick cron info

جزئیات cron job را نمایش می‌دهد.

abrclick cron info <cronId>

مثال:

abrclick cron info cron_xyz789abc

---

abrclick cron update

یک cron job را به‌روز می‌کند — فقط فیلدهایی که شما ارسال می‌کنید تغییر می‌کنند.

abrclick cron update <cronId> [options]

فلگ	توضیح
--name <name>	نام جدید
--schedule <expr>	برنامه جدید cron 5-فیلدی
--command <cmd>	دستور جدید
--timezone <tz>	منطقه زمانی جدید IANA
--enable	فعال‌سازی job
--disable	غیرفعال‌سازی job

مثال:

abrclick cron update cron_xyz789abc --schedule "0 3 * * *" --enable

---

abrclick cron delete

یک cron job را حذف می‌کند.

abrclick cron delete <cronId>

مثال:

abrclick cron delete cron_xyz789abc

---

abrclick cron run

یک اجرای یک‌باره از یک cron job را الان راه‌اندازی می‌کند.

abrclick cron run <cronId>

مثال:

abrclick cron run cron_xyz789abc

---

abrclick cron runs

لیست اجراهای اخیر یک cron job را نمایش می‌دهد.

abrclick cron runs <cronId>

مثال:

abrclick cron runs cron_xyz789abc

---

abrclick cron logs

لاگ‌ها را برای یک اجرای خاص cron نمایش می‌دهد.

abrclick cron logs <cronId> <jobName>

مثال:

abrclick cron logs cron_xyz789abc manual-1234567890

---

دیسک‌های پایدار

مدیریت دیسک‌های پایدار (volumes) — فضای ذخیره‌سازی RWO قابل اتصال به اپ.

abrclick disk list

لیست دیسک‌های یک پروژه را نمایش می‌دهد.

abrclick disk list [--project <id>]

مثال:

abrclick disk list --project proj_xyz789

---

abrclick disk create

یک دیسک پایدار جدید می‌سازد.

abrclick disk create <name> --size <gb> [--mount <path>]

فلگ	توضیح
--project <id>	شناسه پروژه (پیش‌فرض از abrclick.json)
--size <gb>	اندازه دیسک به GB (اجباری)
--mount <path>	مسیر mount داخل کانتینر اپ

مثال:

abrclick disk create uploads --size 10 --mount /app/uploads
abrclick disk create data --size 50

---

abrclick disk info

جزئیات دیسک را نمایش می‌دهد.

abrclick disk info <id>

مثال:

abrclick disk info disk_abc123xyz

---

abrclick disk attach

یک دیسک را به یک اپ متصل می‌کند.

abrclick disk attach <id> --app <appId> [--mount <path>]

فلگ	توضیح
--app <appId>	شناسه اپ برای اتصال دیسک به آن (اجباری)
--mount <path>	مسیر mount داخل کانتینر اپ

مثال:

abrclick disk attach disk_abc123xyz --app app_xyz789abc --mount /data

---

abrclick disk detach

یک دیسک را از اپ آن جدا می‌کند.

abrclick disk detach <id>

مثال:

abrclick disk detach disk_abc123xyz

---

abrclick disk resize

اندازه یک دیسک را تغییر می‌دهد — فقط رشد.

abrclick disk resize <id> --size <gb>

فلگ	توضیح
--size <gb>	اندازه جدید دیسک به GB (فقط می‌تواند افزایش یابد) (اجباری)

مثال:

abrclick disk resize disk_abc123xyz --size 20

اطلاع

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

---

abrclick disk mount

مسیر mount یک دیسک را تغییر می‌دهد.

abrclick disk mount <id> --path <path>

فلگ	توضیح
--path <path>	مسیر mount جدید داخل کانتینر اپ (اجباری)

مثال:

abrclick disk mount disk_abc123xyz --path /new/path

اطلاع

اپ متصل redeploy می‌شود تا مسیر mount جدید را اعمال کند.

---

abrclick disk rm

یک دیسک را حذف می‌کند (ابتدا آن را جدا کنید).

abrclick disk rm <id>

هشدار

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

مثال:

abrclick disk rm disk_abc123xyz

---

ناحیه (Region)

انتخاب و لیست کردن نواحی (multi-region).

abrclick region list

لیست نواحی موجود را نمایش می‌دهد.

abrclick region list

مثال:

abrclick region list

---

abrclick region use

ناحیه را برای دستورات منابع انتخاب می‌کنید (اپ‌ها، دیتابیس‌ها، …).

abrclick region use [slug]

آرگومان	توضیح
[slug]	slug ناحیه (حذف برای انتخاب به صورت تعاملی)

مثال:

abrclick region use ir-thr-1
abrclick region use

---

CI/CD

abrclick ci github

یک workflow GitHub Actions تولید می‌کند: اپ خود را build کنید، به GHCR push کنید، به ابرکلیک deploy کنید.

abrclick ci github [options]

فلگ	توضیح	پیش‌فرض
--source <path>	دایرکتوری پروژه	.
--image <repo>	repo image GHCR (مثلاً ghcr.io/owner/app)؛ پیش‌فرض به git remote	—
-y, --yes	بازنویسی یک workflow موجود بدون سوال	—

مثال:

abrclick ci github
abrclick ci github --source ./my-app --image ghcr.io/myorg/myapp -y

اطلاع

قبل از اینکه بتواند اجرا شود — 2 secret repo GitHub را اضافه کنید:

1. ABRCLICK_TOKEN — به CI اجازه می‌دهد به حساب شما deploy کند. یک key فقط-deploy ایجاد کنید:

   abrclick auth keys create ci --scope deploy

   مقدار abr_sk_... را در secret کپی کنید. (scope deploy = می‌تواند deploy کند، چیز دیگری نه.)

2. GHCR_PULL_TOKEN — به ابرکلیک اجازه می‌دهد image شما را از GHCR PULL کند. یک GitHub PAT (classic) با scope read:packages ایجاد کنید: github.com/settings/tokens → Generate new token. (بسته عمومی GHCR? می‌توانید این را رد کنید — اما workflow هنوز آن را ارسال می‌کند.)

مسیر: Repo → Settings → Secrets and variables → Actions → New repository secret

---

متغیرهای محیطی

مدیریت متغیرهای محیطی در سطح اپ.

abrclick env list

لیست متغیرهای محیطی را نمایش می‌دهد (مقادیر secret پنهان هستند مگر --reveal).

abrclick env list [appId] [--app <id>] [--reveal]

فلگ	توضیح
--app <id>	شناسه اپ (یا خواندن از abrclick.json)
--reveal	نمایش مقادیر secret به صورت متن ساده

مثال:

abrclick env list
abrclick env list app_abc123xyz --reveal

---

abrclick env set

متغیرهای محیطی تنظیم می‌کند.

abrclick env set [pairs...] [--app <id>] [--secret] [--build-time]

فلگ	توضیح
--app <id>	شناسه اپ (یا خواندن از abrclick.json)
--secret	این متغیرها را به عنوان secret علامت‌گذاری کنید (رمزگذاری شده، پنهان)
--build-time	تزریق در زمان build (مثلاً NEXT_PUBLIC_، VITE_)

مثال:

abrclick env set API_KEY=abc123xyz DEBUG=true --secret
abrclick env set NEXT_PUBLIC_API_URL=https://api.example.com --build-time

---

abrclick env import

متغیرهای محیطی را از یک فایل .env وارد می‌کند (تشخیص خودکار .env / .env.example).

abrclick env import [file] [--app <id>] [--secret] [--build-time] [-y]

فلگ	توضیح
--app <id>	شناسه اپ (یا خواندن از abrclick.json)
--secret	همه متغیرهای وارد شده را به عنوان secret علامت‌گذاری کنید
--build-time	همه را در زمان build تزریق کنید
-y, --yes	رد شدن از prompt تأیید

مثال:

abrclick env import .env.production --secret
abrclick env import .env.staging --build-time -y

---

abrclick env unset

یک متغیر محیطی را حذف می‌کند.

abrclick env unset <key> [appId] [--app <id>]

مثال:

abrclick env unset OLD_KEY
abrclick env unset DEBUG app_abc123xyz

---

متغیرهای محیطی سطح پروژه

مدیریت متغیرهای محیطی در سطح پروژه (به تمام اپ‌های پروژه تزریق می‌شود).

abrclick project-env list

لیست متغیرهای محیطی پروژه را نمایش می‌دهد (مقادیر secret پنهان هستند مگر --reveal).

abrclick project-env list [projectId] [--project <id>] [--reveal]

فلگ	توضیح
--project <id>	شناسه پروژه (یا خواندن از abrclick.json)
--reveal	نمایش مقادیر secret به صورت متن ساده

مثال:

abrclick project-env list
abrclick project-env list proj_xyz789abc --reveal

---

abrclick project-env set

متغیرهای محیطی پروژه را تنظیم می‌کند.

abrclick project-env set [pairs...] [--project <id>] [--secret] [--build-time]

فلگ	توضیح
--project <id>	شناسه پروژه (یا خواندن از abrclick.json)
--secret	این متغیرها را به عنوان secret علامت‌گذاری کنید
--build-time	تزریق در زمان build

مثال:

abrclick project-env set DB_POOL_SIZE=20 LOG_LEVEL=info

اطلاع

همه اپ‌های در حال اجرا در پروژه به صورت خودکار redeploy می‌شوند.

---

abrclick project-env unset

یک متغیر محیطی پروژه را حذف می‌کند.

abrclick project-env unset <key> [projectId] [--project <id>]

مثال:

abrclick project-env unset OLD_KEY proj_xyz789abc

---

Abragent (AI)

abrclick agent

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

abrclick agent <prompt> [--project <id>]

آرگومان	توضیح
<prompt>	آنچه می‌خواهید agent انجام دهد (اجباری)

فلگ	توضیح
--project <id>	شناسه پروژه Abragent (اختیاری)

مثال:

abrclick agent "deploy my app to production"
abrclick agent "create a postgres database for my-app" --project proj_xyz789abc

هشدار

این ویژگی در حال توسعه است. agent به توکن شما دسترسی دارد — فقط برای محیط‌های آزمایشی استفاده کنید.

---

متغیرهای محیطی مفید

متغیر	توضیح
ABRCLICK_TOKEN	توکن احراز هویت برای CI/CD (جایگزین abrclick login)
ABRCLICK_APP	شناسه پیش‌فرض اپ (جایگزین --app)
ABRCLICK_PROJECT	شناسه پیش‌فرض پروژه (جایگزین --project)