راهنمای گام‌به‌گام¶

این راهنما یک تابع کوچک را از پوشه‌ای خالی تا دکمه‌ای عملی پیش می‌برد. چند دقیقه زمان می‌برد و جز فایل پیکربندی به چیز دیگری نیاز ندارد.

۱. معرفی پوشه در پیکربندی¶

افزودن پوشه به پیکربندی

config.yaml

function_directory: "./functions"

مسیر نسبت به فایل پیکربندی است. پیکربندی ← قواعد function_directory را ببینید.

فایل functions/greet.yaml را بسازید. پارامتر args نام دارد تا دکمه بتواند آن را پر کند:

نخستین تابع شما

functions/greet.yaml

name: greet
run: "echo Hello {{.args}}"
params:
  - name: args
    required: true
    description: نام برای سلام کردن

دکمه‌ای برای تابع جدید

دکمهٔ سلام کردن

- name: Say hello
  type: button
  function: greet
  args: "world"

بررسی پیکربندی و سپس دیدن موارد بارگذاری‌شده

اعتبارسنجی و سپس فهرست توابع

./telegram-commander validate --config config.yaml
./telegram-commander list-functions --config config.yaml

باید خطی برای greet ببینید. هر خط نام، منشأ تابع و تعداد پارامترهای آن را نشان می‌دهد. CLI ← list-functions را ببینید.

اگر validate ایرادی اعلام کرد، پیام آن نام دکمه و مقدار گم‌شده را مشخص می‌کند؛ قواعد را بررسی کنید.

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

اجرا و مشاهدهٔ خروجی

./telegram-commander run --config config.yaml

در تلگرام /start را بفرستید، سلام کردن را بزنید؛ ربات echo Hello world را اجرا می‌کند و Hello world را در یک بلوک کد برمی‌گرداند.

مقدار args دکمه را تغییر دهید یا دکمهٔ دومی با مقداری متفاوت بیفزایید. خود تابع بدون تغییر می‌ماند:

دو دکمه، یک تابع

دکمه‌های خوشامدگویی

- name: Greet world
  type: button
  function: greet
  args: "world"
- name: Greet team
  type: button
  function: greet
  args: "team"