پرش به محتویات

مرجع CLI

فرمان‌ها از این قالب استفاده می‌کنند

نحو فرمان
telegram-commander <command> [flags]

--config / -c برای فرمان‌هایی که پیکربندی را بارگذاری می‌کنند الزامی است. مسیر می‌تواند نسبت به دایرکتوری کاری جاری یا مطلق باشد. محتوای آن فایل در پیکربندی مستند شده است.

اگر تازه شروع کرده‌اید، اجرا در CLI این فرمان‌ها را به‌ترتیب استفاده نشان می‌دهد.

فرمان‌ها

run

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

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

اجرای ربات
telegram-commander run --config /path/to/configfile.yaml

تغییر پیکربندی به راه‌اندازی مجدد نیاز دارد

ربات پیکربندی را یک‌بار هنگام شروع می‌خواند. پس از ویرایش فایل، فرایند را دوباره راه‌اندازی کنید (برای نمونه systemctl restart telegram-commander).

validate

پیکربندی، توابع و ارجاع‌های دکمه را بدون اجرای ربات اعتبارسنجی می‌کند.

بررسی پیکربندی به‌صورت آفلاین یا آنلاین

اعتبارسنجی پیکربندی
telegram-commander validate --config /path/to/configfile.yaml
telegram-commander validate --config /path/to/configfile.yaml --online

--online به اینترنت نیاز دارد

با --online بررسی از تلگرام نیز می‌پرسد که توکن ربات کار می‌کند یا خیر؛ پس دستگاه باید به تلگرام دسترسی داشته باشد.

version

نسخهٔ برنامه را چاپ می‌کند.

fmt

یک فایل پیکربندی YAML را با قالبی خوانا چاپ می‌کند.

چاپ یا ذخیرهٔ YAML قالب‌بندی‌شده

قالب‌بندی فایل پیکربندی
telegram-commander fmt --config /path/to/configfile.yaml
telegram-commander fmt --config /path/to/configfile.yaml -w

environ

متغیرهای محیطی فرایند را چاپ می‌کند (برای عیب‌یابی واحدهای سرویس مفید است).

list-functions

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

نمایش همهٔ توابع موجود

فهرست توابع موجود
telegram-commander list-functions --config /path/to/configfile.yaml

completion

اسکریپت‌های تکمیل خودکار شِل را تولید می‌کند:

شِل مورد استفادهٔ خود را انتخاب کنید

تولید اسکریپت تکمیل خودکار
telegram-commander completion bash
telegram-commander completion zsh
telegram-commander completion fish
telegram-commander completion powershell

manpage

صفحهٔ راهنما را در خروجی استاندارد می‌نویسد.

صفحات مرتبط