Aller au contenu

Guide pas à pas

Ce guide crée une petite fonction, d’un dossier vide jusqu’à un bouton fonctionnel. Il ne prend que quelques minutes et nécessite uniquement votre fichier de configuration.

1. Indiquer un dossier dans la configuration

Ajouter le dossier à votre configuration

config.yaml
function_directory: "./functions"

Le chemin est relatif au fichier de configuration. Consultez Configuration → règles de function_directory.

2. Écrire le fichier de fonction

Créez functions/greet.yaml. Le paramètre se nomme args afin qu’un bouton puisse le remplir :

Votre première fonction

functions/greet.yaml
name: greet
run: "echo Hello {{.args}}"
params:
  - name: args
    required: true
    description: Name to greet

3. Ajouter un bouton qui l’utilise

Un bouton pour la nouvelle fonction

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

4. Valider et lister les fonctions

Vérifier la configuration puis afficher les fonctions chargées

Valider puis lister les fonctions
./telegram-commander validate --config config.yaml
./telegram-commander list-functions --config config.yaml

Vous devez voir une ligne greet. Chaque ligne indique le nom, l’origine de la fonction et son nombre de paramètres. Consultez CLI → list-functions.

Si validate signale un problème, le message nomme le bouton et la valeur manquante. Consultez Règles.

5. Exécuter le bot et utiliser le bouton

Démarrer le bot au premier plan

Exécuter et suivre la sortie
./telegram-commander run --config config.yaml

Envoyez /start dans Telegram, appuyez sur Say hello : le bot exécute echo Hello world et renvoie Hello world sous forme de bloc de code.

6. Rendre la fonction réutilisable

Modifiez la valeur args du bouton ou ajoutez un second bouton avec une autre valeur. La fonction reste identique :

Deux boutons, une fonction

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

Pages associées